Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

README generator

Project description

Installation

$ [sudo] pip install readme-generator

Features

  • <section-name>.md, attrs/methods/props as sections
  • auto headers
  • readme_generator.Readme class

How it works

<global>/footer.md          global section
<global>/headers.json       global custom headers (optional). example: {"footer":""}
<global>/order.txt          global order. section names line by line

<local>/examples.md         custom section
<local>/order.txt           custom order     (optional)

~/.config/readme-generator - global location, $README_GENERATOR_HOME

README.md:

#### Examples
<examples.md content>

<footer.md content>

Headers

custom header:

  • headers.json {"how":"How it works"}
  • #### Insert Custom header in the first line

without header: headers.json - {"badges":""} or empty first line/empty header

Classes

class __doc__
readme_generator.Readme attrs: disabled, header_lvl, headers, locations, order. methods: load(path), save(path), render()

Executable modules

usage __doc__
python -m readme_generator [location ...] generate README.md

Examples

$ python -m readme_generator location > README.md
readme_generator.Readme("location").save("README.md")

What's Next?

create readme_generator.Readme subclass(es). use attr/methods/props as sections

class Readme(readme_generator.Readme):
    order = ["install", ..., "footer"]
    locations = readme_generator.Readme.locations + [".config/README"]
    headers = {"footer":""}
    footer = "footer ..."

    def install(self):
        return "`$ [sudo] pip install %s`" % self.name

Related projects

python-readme-generator

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
readme_generator-2019.4.2-py2.py3-none-any.whl (7.6 kB) Copy SHA256 hash SHA256 Wheel py2.py3
readme-generator-2019.4.2.tar.gz (3.3 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page