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

  • generate README from <section-name>.md sections
  • auto headers
  • readme_generator.Readme class

How it works

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

<repo>/section-name.md      section
<repo>/order.txt            custom order     (optional)

README.md:

<badges.md content>

#### Section-name
<section-name.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

Examples

README/: README/features.md, README/examples.md, ...

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

global config location

$README_GENERATOR_HOME, default is $XDG_CONFIG_HOME/readme-generator, e.g.:

~/.config/readme-generator

What's Next?

create readme_generator.Readme subclass(es)

class Readme_pypi(readme_generator.Readme):
    order = ["install", ..., "footer"]
    headers = {"footer":""}
    footer = "footer ..."

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

Related projects

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.3.29-py2.py3-none-any.whl (4.9 kB) Copy SHA256 hash SHA256 Wheel py2.py3
readme-generator-2019.3.29.tar.gz (3.5 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