Skip to main content

Format, in a console-friendly and human-readable way, a document specified through its structure

Project description

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...

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

RecursiveDocument-0.5.2.tar.gz (7.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page