readmemaker

Name	readmemaker JSON
Version	1.2.0 JSON
	download
home_page	https://github.com/thombashi/readmemaker
Summary	A Python utility library to help make a README file from document files.
upload_time	2024-12-29 02:21:59
maintainer	None
docs_url	None
author	Tsuyoshi Hombashi
requires_python	>=3.9
license	MIT License
keywords	readme
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/thombashi/readmemaker",
    "name": "readmemaker",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "README",
    "author": "Tsuyoshi Hombashi",
    "author_email": "tsuyoshi.hombashi@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/9c/4e/f6786674d92c069fea0d01eab105729a433107cb9082f6c170826910ddf6/readmemaker-1.2.0.tar.gz",
    "platform": null,
    "description": "readmemaker\n=============\nA Python utility library to help make a README file from document files.\n\n.. image:: https://badge.fury.io/py/readmemaker.svg\n    :target: https://badge.fury.io/py/readmemaker\n    :alt: PyPI package version\n\n.. image:: https://img.shields.io/pypi/pyversions/readmemaker.svg\n    :target: https://pypi.org/project/readmemaker\n    :alt: Supported Python versions\n\nExamples\n=============\n- https://github.com/thombashi/pathvalidate/blob/master/docs/make_readme.py\n    - Output: https://github.com/thombashi/pathvalidate/blob/master/README.rst\n\n- https://github.com/thombashi/pytablewriter/blob/master/docs/make_readme.py\n    - Output: https://github.com/thombashi/pytablewriter/blob/master/README.rst\n\n- https://github.com/thombashi/SimpleSQLite/blob/master/docs/make_readme.py\n    - Output: https://github.com/thombashi/SimpleSQLite/blob/master/README.rst\n\n\nInstallation\n============\n\n::\n\n    pip install readmemaker\n\n\nDependencies\n============\nPython 3.9+\n\n- `path <https://github.com/jaraco/path>`__\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "A Python utility library to help make a README file from document files.",
    "version": "1.2.0",
    "project_urls": {
        "Changelog": "https://github.com/thombashi/readmemaker/releases",
        "Homepage": "https://github.com/thombashi/readmemaker",
        "Source": "https://github.com/thombashi/readmemaker",
        "Tracker": "https://github.com/thombashi/readmemaker/issues"
    },
    "split_keywords": [
        "readme"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4fee455b3d4130b37b328cf079b82c7cc9417d5bf6e57e7482b045a4280e67d1",
                "md5": "b7031e4b143dbbd5ebf4f53ef27043eb",
                "sha256": "5a73eeb9f668e04c0cb1542801fe99822e54fdc9cbe10aafdac70365a40b2289"
            },
            "downloads": -1,
            "filename": "readmemaker-1.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b7031e4b143dbbd5ebf4f53ef27043eb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 4746,
            "upload_time": "2024-12-29T02:21:57",
            "upload_time_iso_8601": "2024-12-29T02:21:57.362898Z",
            "url": "https://files.pythonhosted.org/packages/4f/ee/455b3d4130b37b328cf079b82c7cc9417d5bf6e57e7482b045a4280e67d1/readmemaker-1.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9c4ef6786674d92c069fea0d01eab105729a433107cb9082f6c170826910ddf6",
                "md5": "2e89d47cd66ed620cd41ebd5d17251e9",
                "sha256": "6ab41ab01d604aae986de72e47155d9bf1731335c6be184f5c6890e27ec1d3f2"
            },
            "downloads": -1,
            "filename": "readmemaker-1.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2e89d47cd66ed620cd41ebd5d17251e9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 7893,
            "upload_time": "2024-12-29T02:21:59",
            "upload_time_iso_8601": "2024-12-29T02:21:59.805203Z",
            "url": "https://files.pythonhosted.org/packages/9c/4e/f6786674d92c069fea0d01eab105729a433107cb9082f6c170826910ddf6/readmemaker-1.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-29 02:21:59",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "thombashi",
    "github_project": "readmemaker",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "readmemaker"
}