README.md generate
Project description
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"])
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.2.tar.gz
(2.4 kB
view hashes)
Built Distribution
Close
Hashes for readme_md-0.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2621c5b42d88649ef7f15ddd4d5cb4cb6a1046c4e31e0d132dedb5d104fce498 |
|
MD5 | fdfd1ed05e545d0d54c7cb1d0e9384f8 |
|
BLAKE2b-256 | 51edc3909e70068eda6b567b3150237a03b7bc931198cc178701585a3afce05c |