Metadata-Version: 2.1
Name: readmemaker
Version: 0.5.2
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
Keywords: README
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Provides-Extra: release
Provides-Extra: build
Requires-Dist: path.py
Provides-Extra: build
Requires-Dist: wheel; extra == 'build'
Provides-Extra: release
Requires-Dist: releasecmd (>=0.0.8); extra == 'release'

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


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
============
- `path.py <https://github.com/jaraco/path.py>`__


