readme-md 0.0.2

README.md generate

Install

$ [sudo] pip install readme-md

Features

• static (section.md) and dynamic (python attr) sections
• auto headers (if not exists)
• customizable - settings, subclasses
• pre-defined sections: badges, description requirements, install, features, usage, how, config, examples, todo

Usage

usage: python -m readme_md

Examples

# default README
$ cd path/to/repo
$ python -m readme_md > README.md

static sections (this repo):

./path/to/examples.md
./path/to/features.md

subclass

>>> class Readme_npm(Readme_md):
    ordering = ["badges","description","features","install","examples", ...]

    @property
    def description(self):
        return "<b>%s</b>" % json.loads('package.json')['description']

output

>>> readme.render()             # string
>>> readme.save("README.md")    # save to file

custom headers:

>>> Readme_md(".",headers=dict(badges="",how="How it works"))

disable sections:

>>> Readme_md(".",disabled=["description","badges"])