https://github.com/thombashi/readmemaker

A Python utility library to help make a README file from document files.
https://github.com/thombashi/readmemaker

helper-lib python-library readme

Last synced: 28 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/thombashi/readmemaker
• Owner: thombashi
• License: mit
• Created: 2016-05-29T02:40:42.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-12-29T07:48:34.000Z (5 months ago)
• Last Synced: 2025-04-27T07:35:48.298Z (about 1 month ago)
• Topics: helper-lib, python-library, readme
• Language: Python
• Homepage:
• Size: 96.7 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
readmemaker

=============

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

.. image:: https://badge.fury.io/py/readmemaker.svg

    :target: https://badge.fury.io/py/readmemaker

    :alt: PyPI package version

.. image:: https://img.shields.io/pypi/pyversions/readmemaker.svg

    :target: https://pypi.org/project/readmemaker

    :alt: Supported Python versions

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 `__