{ "info": { "author": "", "author_email": "", "bugtrack_url": null, "classifiers": [ "Framework :: Django", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "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/django-readme-generator.svg?longCache=True)](https://pypi.org/project/django-readme-generator/)\n\n#### Installation\n```bash\n$ [sudo] pip install django-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+ and [python-readme-generator](https://pypi.org/project/python-readme-generator/):\n + `install`, `classes`, `functions`, `executable_modules`, `scripts_usage` sections\n+ django sections:\n + `settings`, `models`, `commands`\n\n#### Config\n```bash\n$ export DJANGO_SETTINGS_MODULE=\"\"\n```\n\n#### Classes\nclass|`__doc__`\n-|-\n`django_readme_generator.Readme` |methods: `getmodules()`, `getapps()`, `getmodels()`, `getcommands()`. sections as methods: `settings()`, `models()`, `commands()`\n\n#### Executable modules\nusage|`__doc__`\n-|-\n`python -m django_readme_generator [location ...]` |generate README.md\n\n#### What's Next?\ncreate custom README class\n\n```python\nimport django_readme_generator\n\nclass Readme(django_readme_generator.Readme):\n headers = {\"badges\":\"\"}\n locations = django_readme_generator.Readme.locations + [\".config/README\"]\n order = ['badges',...]\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 django-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/django-readme-generator.py", "keywords": "readme django", "license": "", "maintainer": "", "maintainer_email": "", "name": "django-readme-generator", "package_url": "https://pypi.org/project/django-readme-generator/", "platform": "", "project_url": "https://pypi.org/project/django-readme-generator/", "project_urls": { "Homepage": "https://github.com/looking-for-a-job/django-readme-generator.py" }, "release_url": "https://pypi.org/project/django-readme-generator/2019.9.7/", "requires_dist": null, "requires_python": "", "summary": "README.md generator for django projects", "version": "2019.9.7" }, "last_serial": 5797029, "releases": { "2019.4.1": [ { "comment_text": "", "digests": { "md5": "9f652b1116cb94c58f228d5a0190f7a6", "sha256": "90c57c86eaaec49c0a75ffe93e58892defdebd2aa1b549a02163a2a9d7ddd265" }, "downloads": -1, "filename": "django_readme_generator-2019.4.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9f652b1116cb94c58f228d5a0190f7a6", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5485, "upload_time": "2019-04-02T16:45:24", "url": "https://files.pythonhosted.org/packages/be/37/0a5d1a840fd9a3df83d83b0339b980a9b930832f5b2c17ec0524ccd8db20/django_readme_generator-2019.4.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "521f1bc944dfa2107ca3e7eb0c69384b", "sha256": "39618fb5267792995f1f07088dce18dabdf5348bffa7d6a678a67d454325698f" }, "downloads": -1, "filename": "django-readme-generator-2019.4.1.tar.gz", "has_sig": false, "md5_digest": "521f1bc944dfa2107ca3e7eb0c69384b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3023, "upload_time": "2019-04-02T16:45:26", "url": "https://files.pythonhosted.org/packages/0d/dd/4f1f8d2c2c820e77fb32be71f00d17ba9b38fcb9fef7a51b427b96fb7239/django-readme-generator-2019.4.1.tar.gz" } ], "2019.4.13": [ { "comment_text": "", "digests": { "md5": "cfc2cc3f125b81bd58cf5e5093ba47dc", "sha256": "4458dce1c410696875050410f5791e3ec4295ee994c3a7ef7d9f154f9058284d" }, "downloads": -1, "filename": "django-readme-generator-2019.4.13.tar.gz", "has_sig": false, "md5_digest": "cfc2cc3f125b81bd58cf5e5093ba47dc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3084, "upload_time": "2019-04-13T07:42:49", "url": "https://files.pythonhosted.org/packages/cc/55/1ccf8898819087124c02799bd779c2b95b497ee259b594ee42aae95f448b/django-readme-generator-2019.4.13.tar.gz" } ], "2019.5.2": [ { "comment_text": "", "digests": { "md5": "0157ba7f5eacbebb0fbfc791bc1907c6", "sha256": "52b1bdb46a60c41e13bdc8eda3124b38ba59776a8afd981f229efb71a19c2b25" }, "downloads": -1, "filename": "django-readme-generator-2019.5.2.tar.gz", "has_sig": false, "md5_digest": "0157ba7f5eacbebb0fbfc791bc1907c6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3075, "upload_time": "2019-05-02T16:00:30", "url": "https://files.pythonhosted.org/packages/29/7b/d124ade9b5628d1d067003e5e3392edce3c8d1147e352bf300148b7261b2/django-readme-generator-2019.5.2.tar.gz" } ], "2019.6.1": [ { "comment_text": "", "digests": { "md5": "5d4293f9a6d831155468bdab9ff21b0d", "sha256": "6977b96648049541ce7b17131ff1df8660a4b5eea88d63458331f876169e2ed2" }, "downloads": -1, "filename": "django-readme-generator-2019.6.1.tar.gz", "has_sig": false, "md5_digest": "5d4293f9a6d831155468bdab9ff21b0d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3086, "upload_time": "2019-06-01T19:32:11", "url": "https://files.pythonhosted.org/packages/29/0d/0a9682c08dbc183efe50b76bf7d69113cf7b622ddc39b9875e321ee44033/django-readme-generator-2019.6.1.tar.gz" } ], "2019.7.6": [ { "comment_text": "", "digests": { "md5": "5c669d3d62fd4fa59564e744f257d0c7", "sha256": "77dcdb153223f1b88e6397a557f2bc90483d4566c5acdd94c624beea323d77fc" }, "downloads": -1, "filename": "django-readme-generator-2019.7.6.tar.gz", "has_sig": false, "md5_digest": "5c669d3d62fd4fa59564e744f257d0c7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3107, "upload_time": "2019-07-06T09:25:40", "url": "https://files.pythonhosted.org/packages/41/9e/8ea5e195ff0d3031904d291793b5dbb5e9f7a0e86f21db83decb0b80a6b0/django-readme-generator-2019.7.6.tar.gz" } ], "2019.9.7": [ { "comment_text": "", "digests": { "md5": "fbe0634ef62cf03784bb5a99afe76405", "sha256": "79e4925577b4283f213c6629d3200c76df0d5d69544417067dffff7ce9bb5b80" }, "downloads": -1, "filename": "django-readme-generator-2019.9.7.tar.gz", "has_sig": false, "md5_digest": "fbe0634ef62cf03784bb5a99afe76405", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3118, "upload_time": "2019-09-07T18:57:40", "url": "https://files.pythonhosted.org/packages/9d/b7/18b689a724de087c0ff9c0314307ff19ba985a220e9ca6724207c3339a75/django-readme-generator-2019.9.7.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fbe0634ef62cf03784bb5a99afe76405", "sha256": "79e4925577b4283f213c6629d3200c76df0d5d69544417067dffff7ce9bb5b80" }, "downloads": -1, "filename": "django-readme-generator-2019.9.7.tar.gz", "has_sig": false, "md5_digest": "fbe0634ef62cf03784bb5a99afe76405", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3118, "upload_time": "2019-09-07T18:57:40", "url": "https://files.pythonhosted.org/packages/9d/b7/18b689a724de087c0ff9c0314307ff19ba985a220e9ca6724207c3339a75/django-readme-generator-2019.9.7.tar.gz" } ] }