Skip to main content generate

Project description


$ [sudo] pip install readme-md


  • static ( 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: python -m readme_md


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

static sections (this repo):



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

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


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

custom headers:

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

disable sections:

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

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

readme-md-0.0.2.tar.gz (2.4 kB view hashes)

Uploaded Source

Built Distribution

readme_md-0.0.2-py2.py3-none-any.whl (8.9 kB view hashes)

Uploaded Python 2 Python 3

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