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

Install

$ [sudo] pip install readme-generator

Features

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

How it works

<global>/footer.md          global section
<global>/headers.json       global custom headers     (optional)
<global>/order.txt          global order
<local>/section-name.md     section
<local>/disabled.txt        disabled sections         (optional)
<local>/order.txt           custom sections/order     (optional)

order.txt:

section-name
footer

README.md:

#### Section-name
<section-name.md content>

#### Footer
<footer.md content>

Headers

custom header:

  1. headers.json {"how":"How it works"}
  2. start first line with #:
#### How it works
section content ...

disable header:

  1. headers.json - {"badges":""}

  2. empty first line:

section content ...

Examples

README/features.md
README/examples.md
README/order.txt
$ python -m readme_generator README > README.md

readme_generator.Readme

readme_generator.Readme("README").save("README.md")

attrs/properties/methods sections

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

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

Config files

file description
disabled.txt disabled sections
headers.json custom headers. example: {"badges":"","how":"How it works"}
order.txt sections order

global settings location:

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

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.4-py2.py3-none-any.whl (4.1 kB) Copy SHA256 hash SHA256 Wheel py2.py3
readme-generator-2019.3.4.tar.gz (3.1 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