readmemaker

A Python utility library to help make a README file from document files.

Examples

• https://github.com/thombashi/pathvalidate/blob/master/docs/make_readme.py

  • Output: https://github.com/thombashi/pathvalidate/blob/master/README.rst

• https://github.com/thombashi/pytablewriter/blob/master/docs/make_readme.py

  • Output: https://github.com/thombashi/pytablewriter/blob/master/README.rst

• https://github.com/thombashi/SimpleSQLite/blob/master/docs/make_readme.py

  • Output: https://github.com/thombashi/SimpleSQLite/blob/master/README.rst

Installation

pip install readmemaker

Dependencies

Python 3.9+

• path