Metadata-Version: 2.1
Name: readmemaker
Version: 1.0.0
Summary: A Python utility library to help make a README file from document files.
Home-page: https://github.com/thombashi/readmemaker
Author: Tsuyoshi Hombashi
Author-email: tsuyoshi.hombashi@gmail.com
License: MIT License
Project-URL: Source, https://github.com/thombashi/readmemaker
Project-URL: Tracker, https://github.com/thombashi/readmemaker/issues
Keywords: README
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing
Requires-Python: >=3.5
Requires-Dist: path (<14,>=13.0.0)
Provides-Extra: dev
Requires-Dist: releasecmd (<1,>=0.1.0) ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: wheel ; extra == 'dev'

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.5+

- `path <https://github.com/jaraco/path>`__


