{ "info": { "author": "", "author_email": "", "bugtrack_url": null, "classifiers": [ "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Documentation" ], "description": "\n\n[![](https://img.shields.io/pypi/pyversions/python-readme-generator.svg?longCache=True)](https://pypi.org/project/python-readme-generator/)\n\n#### Installation\n```bash\n$ [sudo] pip install python-readme-generator\n```\n\n#### Features\n+ based on [readme-generator](https://pypi.org/project/readme-generator/)\n + **`.md`**, **attrs/methods/props as sections**\n + **auto headers**\n+ python sections: `install`, `classes`, `functions`. `setup.cfg` required by default\n\n#### Classes\nclass|`__doc__`\n-|-\n`python_readme_generator.Readme` |methods: `getmodules()`, `getclasses()`, `getfunctions()`. methods as sections: `install()`, `classes()`, `functions()`\n\n#### Executable modules\nusage|`__doc__`\n-|-\n`python -m python_readme_generator [location ...]` |generate README.md\n\n#### What's Next?\ncreate custom README class\n\n```python\nimport python_readme_generator\n\nclass Readme(python_readme_generator.Readme):\n headers = {\"badges\":\"\"}\n locations = python_readme_generator.Readme.locations + [\".config/README\"]\n order = ['badges','install', 'features', 'classes', 'functions', 'next',...]\n\n def badges(self):\n ...\n\nReadme().save(\"README.md\")\n```\n\n#### Related projects\n+ [`readme-generator`](https://pypi.org/project/readme-generator/)\n+ [`python-readme-generator`](https://pypi.org/project/python-readme-generator/)\n+ [`django-readme-generator`](https://pypi.org/project/django-readme-generator/)\n\n

\n python-readme-generator\n

", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/looking-for-a-job/python-readme-generator.py", "keywords": "readme", "license": "", "maintainer": "", "maintainer_email": "", "name": "python-readme-generator", "package_url": "https://pypi.org/project/python-readme-generator/", "platform": "", "project_url": "https://pypi.org/project/python-readme-generator/", "project_urls": { "Homepage": "https://github.com/looking-for-a-job/python-readme-generator.py" }, "release_url": "https://pypi.org/project/python-readme-generator/2019.4.13/", "requires_dist": null, "requires_python": "", "summary": "README.md generator for python projects", "version": "2019.4.13" }, "last_serial": 5587435, "releases": { "2019.3.31": [ { "comment_text": "", "digests": { "md5": "b8cd446ed059869b3f6d212ccb670cdb", "sha256": "c4c5f382f459a8dbc93c10445bd6e2578df772e4a07c7f2ced16e1563b5c08d4" }, "downloads": -1, "filename": "python_readme_generator-2019.3.31-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "b8cd446ed059869b3f6d212ccb670cdb", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 3443, "upload_time": "2019-04-02T16:44:48", "url": "https://files.pythonhosted.org/packages/7f/22/5dc760f22a8d06539250f428659c0a220c945ec6d6252e155cc882960ab7/python_readme_generator-2019.3.31-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1beb0536e19069560b43ecc6dfab58ff", "sha256": "159fddd57b359001f271ba0125bac10d30cd99f210dda86042bdee98f425d6fc" }, "downloads": -1, "filename": "python-readme-generator-2019.3.31.tar.gz", "has_sig": false, "md5_digest": "1beb0536e19069560b43ecc6dfab58ff", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2374, "upload_time": "2019-04-02T16:44:50", "url": "https://files.pythonhosted.org/packages/2d/16/9216ab8cc977d476ba568101a657353c4b243b35ac7ac3728dc2f4873af3/python-readme-generator-2019.3.31.tar.gz" } ], "2019.4.13": [ { "comment_text": "", "digests": { "md5": "6235fe0a003b2acf1ee7455069b45181", "sha256": "261712ae8001ff4774a9ab945ca1e4ab95b084108293e01772dbd1c9a04a19cd" }, "downloads": -1, "filename": "python-readme-generator-2019.4.13.tar.gz", "has_sig": false, "md5_digest": "6235fe0a003b2acf1ee7455069b45181", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2407, "upload_time": "2019-04-13T08:17:08", "url": "https://files.pythonhosted.org/packages/74/0b/a3bdd84db70fbd23fc81955ab9fb60996deb52aa568fd6bb18e4be84454e/python-readme-generator-2019.4.13.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "6235fe0a003b2acf1ee7455069b45181", "sha256": "261712ae8001ff4774a9ab945ca1e4ab95b084108293e01772dbd1c9a04a19cd" }, "downloads": -1, "filename": "python-readme-generator-2019.4.13.tar.gz", "has_sig": false, "md5_digest": "6235fe0a003b2acf1ee7455069b45181", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2407, "upload_time": "2019-04-13T08:17:08", "url": "https://files.pythonhosted.org/packages/74/0b/a3bdd84db70fbd23fc81955ab9fb60996deb52aa568fd6bb18e4be84454e/python-readme-generator-2019.4.13.tar.gz" } ] }