Skip to main content

DO NOT USE THIS LIBRARY: it was written to support InteractiveCommandLine, and the click library is vastly better. I will not fix anything in this library and I’m migrating my own projects to click.

RecursiveDocument is a Python (2.7+ and 3.3+) library formating, in a console-friendly and human-readable way, a document specified through its structure (sections, sub-sections, paragraphs, etc.). It is especially well suited for printing help messages for command-line executables.

It’s licensed under the MIT license. It’s available on the Python package index, its documentation is hosted by Python and its source code is on GitHub.

https://img.shields.io/travis/jacquev6/RecursiveDocument/master.svg https://img.shields.io/coveralls/jacquev6/RecursiveDocument/master.svg https://img.shields.io/codeclimate/github/jacquev6/RecursiveDocument.svg https://img.shields.io/scrutinizer/g/jacquev6/RecursiveDocument.svg https://img.shields.io/pypi/dm/RecursiveDocument.svg https://img.shields.io/pypi/l/RecursiveDocument.svg https://img.shields.io/pypi/v/RecursiveDocument.svg https://img.shields.io/pypi/pyversions/RecursiveDocument.svg https://img.shields.io/pypi/status/RecursiveDocument.svg https://img.shields.io/github/issues/jacquev6/RecursiveDocument.svg https://badge.waffle.io/jacquev6/RecursiveDocument.png?label=ready&title=ready https://img.shields.io/github/forks/jacquev6/RecursiveDocument.svg https://img.shields.io/github/stars/jacquev6/RecursiveDocument.svg

Quick start

Install from PyPI:

$ pip install RecursiveDocument

Import:

>>> from RecursiveDocument import *

Create a document:

>>> doc = Document().add(
...   Section("Introduction")
...     .add("This is the first paragraph of a very interesting story. It begins with this paragraph.")
...     .add("After the first paragraph comes the second paragraph. As incredible as it may sound, it can go on and on and on...")
... )

And print it:

>>> print doc.format()
Introduction
  This is the first paragraph of a very interesting story. It begins
  with this paragraph.
<BLANKLINE>
  After the first paragraph comes the second paragraph. As incredible
  as it may sound, it can go on and on and on...

Release files for RecursiveDocument 0.5.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for RecursiveDocument 0.5.2
File Size Uploaded
RecursiveDocument-0.5.2.tar.gz 7.7 kB Details

Release files / RecursiveDocument-0.5.2.tar.gz

Download URL RecursiveDocument-0.5.2.tar.gz
Size 7.7 kB
Tags Source
SHA-256 checksum
How to use checksums
52bbb1500fd2ee3ecfb3d9515b0c8ba71c5b156dda1b1d52f59deef5bc01cb1e
BLAKE2b-256 checksum
How to use checksums
55a53c31d255d6bc4f5201de846b1788e6d6281aeaca75790eb98dcf5e3beb5a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/2.7.14

Release history Release notifications | RSS feed

This release

0.5.2 This release

1 release file

0.5.1

1 release file

0.5.0

1 release file

0.4.0

1 release file

0.3.0

1 release file

0.2.0

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page