README.md generate
Project description
Install
$ [sudo] pip install readme-md
Features
- static (
section.md
) and dynamic (python attr) sections - auto headers (if header not exists in section source)
- customizable - settings, subclasses
- pre-defined sections:
badges
,description
requirements
,install
,features
,usage
,how
,config
,examples
,todo
Usage
Usage: python -m readme_md [OPTIONS]
Options:
--help Show this message and exit.
Examples
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"])
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
readme-md-0.0.1.tar.gz
(2.4 kB
view hashes)