{ "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", "Topic :: Software Development :: Documentation" ], "description": "\n\n[![](https://img.shields.io/pypi/pyversions/readme-generator.svg?longCache=True)](https://pypi.org/project/readme-generator/)\n\n#### Installation\n```bash\n$ [sudo] pip install readme-generator\n```\n\n#### Features\n+ **`.md`**, **attrs/methods/props as sections**\n+ **auto headers**\n+ `readme_generator.Readme` class\n\n#### How it works\n```\n/footer.md global section\n/headers.json global custom headers (optional). example: {\"footer\":\"\"}\n/order.txt global order. section names line by line\n\n/examples.md custom section\n/order.txt custom order (optional)\n```\n`~/.config/readme-generator` - global location, `$README_GENERATOR_HOME`\n\n`README.md`:\n```markdown\n#### Examples\n\n\n\n```\n\n#### Headers\n**custom header**:\n+ `headers.json` `{\"how\":\"How it works\"}`\n+ `#### Insert Custom header in the first line`\n\n**without header**: `headers.json` - `{\"badges\":\"\"}` or empty first line/empty header\n\n#### Classes\nclass|`__doc__`\n-|-\n`readme_generator.Readme` |attrs: `disabled`, `header_lvl`, `headers`, `locations`, `order`. methods: `load(path)`, `save(path)`, `render()`\n\n#### Executable modules\nusage|`__doc__`\n-|-\n`python -m readme_generator [location ...]` |generate README.md\n\n#### Examples\n```bash\n$ python -m readme_generator location > README.md\n```\n\n```python\nreadme_generator.Readme(\"location\").save(\"README.md\")\n```\n\n#### What's Next?\ncreate `readme_generator.Readme` subclass(es). use attr/methods/props as sections\n\n```python\nclass Readme(readme_generator.Readme):\n order = [\"install\", ..., \"footer\"]\n locations = readme_generator.Readme.locations + [\".config/README\"]\n headers = {\"footer\":\"\"}\n footer = \"footer ...\"\n\n def install(self):\n return \"`$ [sudo] pip install %s`\" % self.name\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/readme-generator.py", "keywords": "readme generator", "license": "", "maintainer": "", "maintainer_email": "", "name": "readme-generator", "package_url": "https://pypi.org/project/readme-generator/", "platform": "", "project_url": "https://pypi.org/project/readme-generator/", "project_urls": { "Homepage": "https://github.com/looking-for-a-job/readme-generator.py" }, "release_url": "https://pypi.org/project/readme-generator/2019.4.13/", "requires_dist": null, "requires_python": "", "summary": "README generator", "version": "2019.4.13" }, "last_serial": 5587420, "releases": { "2019.3.16": [ { "comment_text": "", "digests": { "md5": "e273cdc0574f601da6ec8a99fe9dfb55", "sha256": "95b994de202f99732fab214dd7a5718e9772fab2fc37d27b8b72e00fe751a12f" }, "downloads": -1, "filename": "readme_generator-2019.3.16-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "e273cdc0574f601da6ec8a99fe9dfb55", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4379, "upload_time": "2019-03-16T13:45:05", "url": "https://files.pythonhosted.org/packages/28/24/3df54a6a89b4dcac0457c3b339bab13486590ccd0c1b64865ee51eb41d97/readme_generator-2019.3.16-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0ec220ef05e1c90e9b5d2f70b3782dda", "sha256": "d45f8c0ee6220609bb853fefe464c61299a3dd4f26e6b3b40ccaf3f4cba3b64d" }, "downloads": -1, "filename": "readme-generator-2019.3.16.tar.gz", "has_sig": false, "md5_digest": "0ec220ef05e1c90e9b5d2f70b3782dda", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3337, "upload_time": "2019-03-16T13:45:07", "url": "https://files.pythonhosted.org/packages/27/06/06a279a3e42ca80bc00868dff0cd9efc001e8ddb4e5a6d291de71c321b1c/readme-generator-2019.3.16.tar.gz" } ], "2019.3.22": [ { "comment_text": "", "digests": { "md5": "c380203d24fa8d5356e7cf4dca244f01", "sha256": "006a05cd660cd2776432337bd357c87a3108001dc773123efb94d4951c73ec09" }, "downloads": -1, "filename": "readme_generator-2019.3.22-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c380203d24fa8d5356e7cf4dca244f01", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 147559, "upload_time": "2019-03-24T11:19:08", "url": "https://files.pythonhosted.org/packages/92/98/11096c69ffc6156d3bfc1c0d238a614a60e1f56af6fc2cf910961fee11ef/readme_generator-2019.3.22-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6db7a9d11f2d265873bd211885860987", "sha256": "3538ed9c075a8cf7ea4e373ec3d221bd4dd056e45508fa1f3c036c172d3aacaa" }, "downloads": -1, "filename": "readme-generator-2019.3.22.tar.gz", "has_sig": false, "md5_digest": "6db7a9d11f2d265873bd211885860987", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3540, "upload_time": "2019-03-24T11:19:10", "url": "https://files.pythonhosted.org/packages/d5/db/44659570a76c0a29dcc80decdbce218b07335db3dd8662ff7c600ce7145f/readme-generator-2019.3.22.tar.gz" } ], "2019.3.29": [ { "comment_text": "", "digests": { "md5": "d698cc45901c7bc72e9755a4045f3669", "sha256": "8c888172bada86f53017986f637115bb2b35e222e5b93979d191254050c5c4d0" }, "downloads": -1, "filename": "readme_generator-2019.3.29-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d698cc45901c7bc72e9755a4045f3669", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4885, "upload_time": "2019-03-29T13:33:25", "url": "https://files.pythonhosted.org/packages/d7/37/a39a1de47b5c01633252d208df4c2e46394a4117078831d65d56bc41bf51/readme_generator-2019.3.29-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7c6165aebb3c73a7453201cb961bb6f8", "sha256": "2a096999986918f07bbbafcc83c5e81dc1f9e1912957cef28114bd251dc54496" }, "downloads": -1, "filename": "readme-generator-2019.3.29.tar.gz", "has_sig": false, "md5_digest": "7c6165aebb3c73a7453201cb961bb6f8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3522, "upload_time": "2019-03-29T13:33:27", "url": "https://files.pythonhosted.org/packages/c8/ec/0657e93adcd0fd3476b375b6fecffc4d4f8b493a6f3e1cc97248dc424695/readme-generator-2019.3.29.tar.gz" } ], "2019.3.4": [ { "comment_text": "", "digests": { "md5": "ef0d2f5289a1b80121e08d166109152e", "sha256": "ba11c629ae63087cfae26aa8d9f3bc2b21f5e6ec77913434c50d5b0a0f0c5ef2" }, "downloads": -1, "filename": "readme_generator-2019.3.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ef0d2f5289a1b80121e08d166109152e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4124, "upload_time": "2019-03-05T07:17:48", "url": "https://files.pythonhosted.org/packages/6e/9f/067bef412a898f8a3ab38328efeb238e7840c99581702a8b9e4c26425a2c/readme_generator-2019.3.4-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c1f3656018e48babd9a8df848ad599dd", "sha256": "835f59afbd2bf105bb1b3f403dba60bc9e542127ea072d3f16c8a45f92427697" }, "downloads": -1, "filename": "readme-generator-2019.3.4.tar.gz", "has_sig": false, "md5_digest": "c1f3656018e48babd9a8df848ad599dd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3109, "upload_time": "2019-03-05T07:17:51", "url": "https://files.pythonhosted.org/packages/d1/4c/2aa27c8c6380315787661f1adb1b3fb3fe0987f10b72e4dbe850279823a0/readme-generator-2019.3.4.tar.gz" } ], "2019.3.5": [ { "comment_text": "", "digests": { "md5": "b8ec0701f0506d3f7d5e8f03431cb010", "sha256": "507646c2b75b28fe5e3c838306f1ba08632d5149f8b1c0a037a2393e0c09e3bb" }, "downloads": -1, "filename": "readme_generator-2019.3.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "b8ec0701f0506d3f7d5e8f03431cb010", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4168, "upload_time": "2019-03-05T14:28:48", "url": "https://files.pythonhosted.org/packages/dd/41/8da6892c9c8f7280fbe555b3dd22a5a2ae9844306a0f47ba37676dde27d2/readme_generator-2019.3.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5d42376d9eff2e197abd9b87fe5edfed", "sha256": "a6af596c57e043b9b2d546d89d6e4ca1791a8fd590837e25bd591d45ac9406fa" }, "downloads": -1, "filename": "readme-generator-2019.3.5.tar.gz", "has_sig": false, "md5_digest": "5d42376d9eff2e197abd9b87fe5edfed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3151, "upload_time": "2019-03-05T14:28:50", "url": "https://files.pythonhosted.org/packages/a3/bd/9e2e24f4621234d7b552818ad5832c476445511cc85de101c88083eef9bf/readme-generator-2019.3.5.tar.gz" } ], "2019.3.9": [ { "comment_text": "", "digests": { "md5": "724b54455449b1052735b5fbea979ec0", "sha256": "529c3314a4c5e382c1718e9e9297589165ec2ca6059660928f12379da68ac2a3" }, "downloads": -1, "filename": "readme_generator-2019.3.9-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "724b54455449b1052735b5fbea979ec0", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 22229, "upload_time": "2019-03-08T21:20:15", "url": "https://files.pythonhosted.org/packages/31/9e/4826a777601618145af36a383013f88e6a14f0816571fbe4d80c7b62110e/readme_generator-2019.3.9-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "75d608a40eda61169c811a412b635d8e", "sha256": "cc86a893e97153b339440d257744e3572ba7d00f0957276cff993ed867060333" }, "downloads": -1, "filename": "readme-generator-2019.3.9.tar.gz", "has_sig": false, "md5_digest": "75d608a40eda61169c811a412b635d8e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3142, "upload_time": "2019-03-08T21:20:17", "url": "https://files.pythonhosted.org/packages/93/8c/d7c9b5eabfb109015f03091d98ec9871ce9ea624474aad5a49a3903991a5/readme-generator-2019.3.9.tar.gz" } ], "2019.4.13": [ { "comment_text": "", "digests": { "md5": "b03455af3134a4c29b378ce7c21b1bcd", "sha256": "90a93cda670e590bc2fcda3ffa40303633f6c2c1dbe0dfe1927e02ece40e7e98" }, "downloads": -1, "filename": "readme-generator-2019.4.13.tar.gz", "has_sig": false, "md5_digest": "b03455af3134a4c29b378ce7c21b1bcd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3359, "upload_time": "2019-04-13T08:18:31", "url": "https://files.pythonhosted.org/packages/05/d3/4c0e7c4998dce17b73545c36baf37a0ee538a646ec948be5b86738d25100/readme-generator-2019.4.13.tar.gz" } ], "2019.4.2": [ { "comment_text": "", "digests": { "md5": "1c5c9c3072d1b9474ac76389a7edd6d1", "sha256": "034e497c7338443602ce0cc1135aadb20c544497861aac8982eec87df02a1680" }, "downloads": -1, "filename": "readme_generator-2019.4.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1c5c9c3072d1b9474ac76389a7edd6d1", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 7592, "upload_time": "2019-04-02T16:51:34", "url": "https://files.pythonhosted.org/packages/46/87/c87a10d629f974fa0a90a4ab2748331471d1343ee52ba52b21a525f637dd/readme_generator-2019.4.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "dafddca43b29df282d85894cfa7764bd", "sha256": "c1bbdb2a95b20ce7104d26531aaf53f5a34239b87ac98c16a689b011bbb451a9" }, "downloads": -1, "filename": "readme-generator-2019.4.2.tar.gz", "has_sig": false, "md5_digest": "dafddca43b29df282d85894cfa7764bd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3321, "upload_time": "2019-04-02T16:51:35", "url": "https://files.pythonhosted.org/packages/22/fb/b2b571b1e55a8d02e1665bd34689783e8139e7d8d419378c11c589caf09c/readme-generator-2019.4.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b03455af3134a4c29b378ce7c21b1bcd", "sha256": "90a93cda670e590bc2fcda3ffa40303633f6c2c1dbe0dfe1927e02ece40e7e98" }, "downloads": -1, "filename": "readme-generator-2019.4.13.tar.gz", "has_sig": false, "md5_digest": "b03455af3134a4c29b378ce7c21b1bcd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3359, "upload_time": "2019-04-13T08:18:31", "url": "https://files.pythonhosted.org/packages/05/d3/4c0e7c4998dce17b73545c36baf37a0ee538a646ec948be5b86738d25100/readme-generator-2019.4.13.tar.gz" } ] }