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

Project description


$ [sudo] pip install python-readme-generator


  • based on readme-generator
    • <section-name>.md, attrs/methods/props as sections
    • auto headers
  • python sections: install, classes, functions. setup.cfg required by default


class __doc__
python_readme_generator.Readme methods: getmodules(), getclasses(), getfunctions(). methods as sections: install(), classes(), functions()

Executable modules

usage __doc__
python -m python_readme_generator [location ...] generate

What's Next?

create custom README class

import python_readme_generator

class Readme(python_readme_generator.Readme):
    headers = {"badges":""}
    locations = python_readme_generator.Readme.locations + [".config/README"]
    order = ['badges','install', 'features', 'classes', 'functions', 'next',...]

    def badges(self):


Related projects


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
python-readme-generator-2019.4.13.tar.gz (2.4 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