{ "info": { "author": "tell-k", "author_email": "ffk2005@gmail.com", "bugtrack_url": null, "classifiers": [ "Environment :: Web Environment", "Framework :: Django", "Framework :: Django :: 1.10", "Framework :: Django :: 1.11", "Framework :: Django :: 1.5", "Framework :: Django :: 1.6", "Framework :: Django :: 1.7", "Framework :: Django :: 1.8", "Framework :: Django :: 1.9", "Framework :: Django :: 2.0", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Documentation", "Topic :: Documentation :: Sphinx" ], "description": "Create models definitions document from your django project. This project help the documentation related to Django models.\n\n|travis| |coveralls| |version| |license| |requires|\n\nQuick start\n=============\n\n1. Add \"modelsdoc\" to your INSTALLED_APPS setting like this\n\n::\n\n INSTALLED_APPS = (\n ...\n 'modelsdoc',\n )\n\n2. Run **python manage.py listing_models** to listing model definition\n\n* You can see `the results `_ of executing the command to `tests/models.py `_.\n\nOption\n=======\n\n--app(-a)\n-----------\n\nYou can pass specify app name. Listing only the specified app.\n\n::\n\n $ python manage.py listing_models --app polls\n\n--output(-o)\n-------------\n\nIt writes the results to the specified file.\n\n::\n\n $ python manage.py listing_models --output sample.rst\n\n--format(-f)\n-------------\n\nYou can choice output format. **rst** (reStructuredText) or **md** (Markdown). Default format is **rst**.\n\n::\n\n $ python manage.py listing_models --format md\n\nCustomize Settings\n===================\n\nMODELSDOC_APPS\n----------------\n\nYou can specify the apps and change the order.\n\n::\n\n # output only models of poll\n MODELSDOC_APPS = (polls,)\n\n\nMODELSDOC_DISPLAY_FIELDS\n-------------------------\n\nYou can specify the field value and change the order.\n\n::\n\n MODELSDOC_DISPLAY_FIELDS = (\n ('Fullname', 'verbose_name'),\n ('Name', 'name'),\n ('Type', 'db_type'),\n ('PK', 'primary_key'),\n ('Unique', 'unique'),\n ('Index', 'db_index'),\n ('Null/Blank', 'null_blank'),\n ('Comment', 'comment'),\n )\n\nMODELSDOC_MODEL_OPTIONS\n-------------------------\n\n# TODO more documented\n\n::\n\n MODELSDOC_MODEL_OPTIONS = (\n 'unique_together',\n 'index_together',\n 'ordering',\n 'permissions',\n 'get_latest_by',\n 'order_with_respect_to',\n 'db_tablespace',\n 'abstract',\n 'swappable',\n 'select_on_save',\n 'default_permissions',\n 'default_related_name'\n )\n\nOther settings\n---------------\n\n# TODO more documented\n\n::\n\n MODELSDOC_OUTPUT_TEMPLATE = 'modelsdoc/models'\n MODELSDOC_OUTPUT_FORMAT = 'rst' # default format\n MODELSDOC_MODEL_WRAPPER = 'modelsdoc.wrappers.ModelWrapper'\n MODELSDOC_FIELD_WRAPPER = 'modelsdoc.wrappers.FieldWrapper'\n MODELSDOC_INCLUDE_AUTO_CREATED = True\n\n\nPython and Django Support\n=========================\n\n.. csv-table::\n :widths: 10, 10, 10, 10, 10, 10, 10, 10, 10\n\n \"\u3000\", \"Django.1.5\", \"Django1.6\", \"Django1.7\", \"Django1.8\", \"Django1.9\", \"Django1.10\", \"Django1.11\", \"Django2.0\"\n \"Python 2.7\",\"\u25ef\",\"\u25ef\",\"\u25ef\",\"\u25ef\",\"\u25ef\",\"\u25ef\",\"\u25ef\",\"\"\n \"PyPy\",\"\u25ef\",\"\u25ef\",\"\u25ef\",\"\u25ef\",\"\u25ef\",\"\u25ef\",\"\u25ef\",\"\"\n \"Python 3.3\",\"\",\"\",\"\u25ef\",\"\u25ef\",\"\",\"\",\"\",\"\"\n \"Python 3.4\",\"\",\"\",\"\u25ef\",\"\u25ef\",\"\u25ef\",\"\u25ef\",\"\u25ef\",\"\u25ef\" \n \"Python 3.5\",\"\",\"\",\"\",\"\u25ef\",\"\u25ef\",\"\u25ef\",\"\u25ef\",\"\u25ef\"\n \"Python 3.6\",\"\",\"\",\"\",\"\u25ef\",\"\u25ef\",\"\u25ef\",\"\u25ef\",\"\u25ef\"\n\n\nLicense\n=======\n\nMIT Licence. See the LICENSE file for specific terms.\n\n\nAuthors\n=========\n\n* tell-k \n* wanshot\n\nHistory\n=======\n\n0.1.9(Feb 8, 2018)\n---------------------\n* Fix `Set section length dynamically `_. Thanks to wanshot\n\n0.1.8(Dec 3, 2017)\n---------------------\n* Add Support Django2.0\n\n0.1.7(May 29, 2017)\n---------------------\n* Add Support Django1.11 and Python 3.6\n\n0.1.6(Nov 4, 2016)\n---------------------\n* Add Support Django1.10\n\n0.1.5(May 4, 2016)\n---------------------\n* Add Support Python3.5 and Django1.9\n\n0.1.4(Sep 23, 2015)\n---------------------\n* Fixed bug. When print models, linebreak is ignored.\n* Add ManyToManyField's info on \"listing_models\" results.\n\n0.1.3(Jul 19, 2015)\n---------------------\n* Fixed bug. install test code.\n* Add new option \"MODELSDOC_INCLUDE_AUTO_CREATED\"\n\n0.1.2(Jun 21, 2015)\n---------------------\n* Bug fixed. Not include output templates.\n\n0.1.0(Jun 21, 2015)\n---------------------\n* First release\n\n\n.. |travis| image:: https://travis-ci.org/tell-k/django-modelsdoc.svg?branch=master\n :target: https://travis-ci.org/tell-k/django-modelsdoc\n\n.. |coveralls| image:: https://coveralls.io/repos/tell-k/django-modelsdoc/badge.png\n :target: https://coveralls.io/r/tell-k/django-modelsdoc\n :alt: coveralls.io\n\n.. |requires| image:: https://requires.io/github/tell-k/django-modelsdoc/requirements.svg?branch=master\n :target: https://requires.io/github/tell-k/django-modelsdoc/requirements/?branch=master\n :alt: requirements status\n\n.. |version| image:: https://img.shields.io/pypi/v/django-modelsdoc.svg\n :target: http://pypi.python.org/pypi/django-modelsdoc/\n :alt: latest version\n\n.. |license| image:: https://img.shields.io/pypi/l/django-modelsdoc.svg\n :target: http://pypi.python.org/pypi/django-modelsdoc/\n :alt: license\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/tell-k/django-modelsdoc", "keywords": "django models document documentation", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "django-modelsdoc", "package_url": "https://pypi.org/project/django-modelsdoc/", "platform": "", "project_url": "https://pypi.org/project/django-modelsdoc/", "project_urls": { "Homepage": "https://github.com/tell-k/django-modelsdoc" }, "release_url": "https://pypi.org/project/django-modelsdoc/0.1.9/", "requires_dist": [ "Django", "Sphinx" ], "requires_python": "", "summary": "Create models definitions document from your Django project.", "version": "0.1.9" }, "last_serial": 3563730, "releases": { "0.1.2": [ { "comment_text": "", "digests": { "md5": "c6e74b49669ec2aa5b8c66aee5f3138c", "sha256": "58465145e903ed4fb44171db3e5af22df03d21dca7c72fb3549d9a597ac8a0d3" }, "downloads": -1, "filename": "django_modelsdoc-0.1.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c6e74b49669ec2aa5b8c66aee5f3138c", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16015, "upload_time": "2015-06-21T14:32:39", "url": "https://files.pythonhosted.org/packages/65/79/1505012b112b445b6dcb5dcfbacf0bce543177828d448085213361196477/django_modelsdoc-0.1.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5a476c81b4289726c209845ad2d2e552", "sha256": "b1889d5bdf6ec226d57e353cbf5325543f54da34a9ef832009a9725744f352df" }, "downloads": -1, "filename": "django-modelsdoc-0.1.2.tar.gz", "has_sig": false, "md5_digest": "5a476c81b4289726c209845ad2d2e552", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14053, "upload_time": "2015-06-21T14:32:35", "url": "https://files.pythonhosted.org/packages/42/04/00fc15566aea2310457cc752f0ae504110e582d9484288ca93d6a70b3caf/django-modelsdoc-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "f54cb0243ebb5cbac7db4668e56b81a6", "sha256": "ea3285872a1a8a3fc11707991464b33da7be134eaed798c910af84e45138f2e3" }, "downloads": -1, "filename": "django_modelsdoc-0.1.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f54cb0243ebb5cbac7db4668e56b81a6", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11674, "upload_time": "2015-07-18T16:18:40", "url": "https://files.pythonhosted.org/packages/38/ea/ed950d3a08b3bf7907bb30f5703693ed5a608267534613c73e042b1e382d/django_modelsdoc-0.1.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8a9c25a56b17eaf95d4ef3906a3f20e6", "sha256": "46811435b1dc31eb9a174f479ef4136023f08cdcedccb756ddbb2a938cdae143" }, "downloads": -1, "filename": "django-modelsdoc-0.1.3.tar.gz", "has_sig": false, "md5_digest": "8a9c25a56b17eaf95d4ef3906a3f20e6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15015, "upload_time": "2015-07-18T16:18:37", "url": "https://files.pythonhosted.org/packages/ca/29/d3e45a523838f05b93be6992228e85f52fcb72309183618a7b9eb573a357/django-modelsdoc-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "bbc3b2b05186e685544e3d27f78f02a7", "sha256": "bcb943e29083e0cafb755cc66e5b4098de5ca990411e82426be82994520983e4" }, "downloads": -1, "filename": "django_modelsdoc-0.1.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "bbc3b2b05186e685544e3d27f78f02a7", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 13634, "upload_time": "2015-09-23T16:40:30", "url": "https://files.pythonhosted.org/packages/f6/32/f432d5fde4bbc22eeec67a30c57468733551ad47e290af7a0ca7a632585e/django_modelsdoc-0.1.4-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "036b8ce50661b02f8e2a8adfb08c1fbd", "sha256": "d3e7b0298ce216d6677f513be90143de42ca7ca7e2f067ceb60796cce3216812" }, "downloads": -1, "filename": "django-modelsdoc-0.1.4.tar.gz", "has_sig": false, "md5_digest": "036b8ce50661b02f8e2a8adfb08c1fbd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15759, "upload_time": "2015-09-23T16:40:37", "url": "https://files.pythonhosted.org/packages/11/ee/58c4d79125d3f2daf1561761f4e076ad479b9cae00b4365ae1182778c311/django-modelsdoc-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "0d89642f188762514f460267587c816d", "sha256": "fddf4372b49796d7534c6c5c77f0ff95b94755c91ec46b55af7cefcc3dcf5f24" }, "downloads": -1, "filename": "django_modelsdoc-0.1.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "0d89642f188762514f460267587c816d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 12531, "upload_time": "2016-05-03T17:04:45", "url": "https://files.pythonhosted.org/packages/e5/75/216c7d0f76fe4a497d058ba6ecfea66631c138b776bf5b339bfaf1a7d41f/django_modelsdoc-0.1.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "80767bbff906fbf7d5e150db9f0b2d40", "sha256": "7d553a1aa554a160ad3c790b8fa0d6fb5e6eddf0efdfc7d297b1319c5d48295f" }, "downloads": -1, "filename": "django-modelsdoc-0.1.5.tar.gz", "has_sig": false, "md5_digest": "80767bbff906fbf7d5e150db9f0b2d40", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16521, "upload_time": "2016-05-03T17:07:22", "url": "https://files.pythonhosted.org/packages/52/f8/25f12105f08cfb16496db4cb68cb810bd65d58213b4798e73e5fd9bca4ea/django-modelsdoc-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "015b408f40c6fb6e85d4be881f814afa", "sha256": "3f2104261c2e0a80c338950398389a909e1c8d1aafce12816c39328712d1ba29" }, "downloads": -1, "filename": "django_modelsdoc-0.1.6-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "015b408f40c6fb6e85d4be881f814afa", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 12505, "upload_time": "2016-11-04T14:23:03", "url": "https://files.pythonhosted.org/packages/9f/33/f5f160350eaef8479029749f05989ffea5dd82a8d726551a60078cac586d/django_modelsdoc-0.1.6-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2a5128679a7213e0e094e95196eb1c06", "sha256": "dd00c5818b269522c8509ca2784a3b8004699807fae3628acfe2b01180233fc3" }, "downloads": -1, "filename": "django-modelsdoc-0.1.6.tar.gz", "has_sig": false, "md5_digest": "2a5128679a7213e0e094e95196eb1c06", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16672, "upload_time": "2016-11-04T14:23:07", "url": "https://files.pythonhosted.org/packages/6c/0c/e4f114f7f79cec210d87c6d32b352878ae84388c3b48e933acfb46a92533/django-modelsdoc-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "8ce044942192b9b6d865f61d03a25505", "sha256": "19f30275b9b6a8ddd5f99592bf7987938a52988dadfc70b49d642a7dc7a22209" }, "downloads": -1, "filename": "django_modelsdoc-0.1.7-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "8ce044942192b9b6d865f61d03a25505", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 12574, "upload_time": "2017-05-29T01:54:32", "url": "https://files.pythonhosted.org/packages/96/e2/7adc30bdd51d75390bc133d51240aa564fb5fe51df75acd3bb77c62b667e/django_modelsdoc-0.1.7-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3563b467a02f7459cd462bf391449b5a", "sha256": "ac96eda4d2570f7fc534d7fdafca6835c61ac8c025486879f43fa6d1597ec51b" }, "downloads": -1, "filename": "django-modelsdoc-0.1.7.tar.gz", "has_sig": false, "md5_digest": "3563b467a02f7459cd462bf391449b5a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16767, "upload_time": "2017-05-29T01:54:33", "url": "https://files.pythonhosted.org/packages/3a/8b/7ac219573881c7e3367df63c9034d342383ab9ebc6ff3c9ac825658e7cb6/django-modelsdoc-0.1.7.tar.gz" } ], "0.1.8": [ { "comment_text": "", "digests": { "md5": "6fce9c66bce0f16263233fa257fd1d5e", "sha256": "cb4cdf8350d1ff6a378c1d2bec27676d64d0babfb509f1c37b2ee42fc00bd1c3" }, "downloads": -1, "filename": "django_modelsdoc-0.1.8-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "6fce9c66bce0f16263233fa257fd1d5e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 12639, "upload_time": "2017-12-02T19:32:58", "url": "https://files.pythonhosted.org/packages/15/16/621858af767f8b2493b23271f7ae22ec5fad28cf9e0d96dae74f55ac6bc0/django_modelsdoc-0.1.8-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e81b8252e5cd0f11c31df89a2dca8836", "sha256": "d6af5d39bd3528d6e0dfb79ef04888120932816514232fab78940ea91aa20d2c" }, "downloads": -1, "filename": "django-modelsdoc-0.1.8.tar.gz", "has_sig": false, "md5_digest": "e81b8252e5cd0f11c31df89a2dca8836", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16946, "upload_time": "2017-12-02T19:33:00", "url": "https://files.pythonhosted.org/packages/dc/47/3fde6d3e2b7cdfa95125f0a98b30714e1be1651f016d1507fb737e461d26/django-modelsdoc-0.1.8.tar.gz" } ], "0.1.9": [ { "comment_text": "", "digests": { "md5": "a72d99a3fb02462fb5ec51cff995a8de", "sha256": "baa3db33acc2a9fab834976c787dce1c07f2610627c2b009313deff5f37e742b" }, "downloads": -1, "filename": "django_modelsdoc-0.1.9-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a72d99a3fb02462fb5ec51cff995a8de", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 13185, "upload_time": "2018-02-08T13:46:16", "url": "https://files.pythonhosted.org/packages/99/17/f952801d71769798d077a3dd96d8648c5866418e93401e1df72df5a7ff7d/django_modelsdoc-0.1.9-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a461c3401897b8e5d1d6ed12a2983959", "sha256": "7ea83bd21698e019101cb3aa3ef4828aed80c72e0ebf8c5b78553c1e0e5e130b" }, "downloads": -1, "filename": "django-modelsdoc-0.1.9.tar.gz", "has_sig": false, "md5_digest": "a461c3401897b8e5d1d6ed12a2983959", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17964, "upload_time": "2018-02-08T13:46:18", "url": "https://files.pythonhosted.org/packages/69/05/93d4ddf423cd147c46b4d80d77fc7b0f5dd1d07cbec91694875a0b5454cb/django-modelsdoc-0.1.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a72d99a3fb02462fb5ec51cff995a8de", "sha256": "baa3db33acc2a9fab834976c787dce1c07f2610627c2b009313deff5f37e742b" }, "downloads": -1, "filename": "django_modelsdoc-0.1.9-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a72d99a3fb02462fb5ec51cff995a8de", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 13185, "upload_time": "2018-02-08T13:46:16", "url": "https://files.pythonhosted.org/packages/99/17/f952801d71769798d077a3dd96d8648c5866418e93401e1df72df5a7ff7d/django_modelsdoc-0.1.9-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a461c3401897b8e5d1d6ed12a2983959", "sha256": "7ea83bd21698e019101cb3aa3ef4828aed80c72e0ebf8c5b78553c1e0e5e130b" }, "downloads": -1, "filename": "django-modelsdoc-0.1.9.tar.gz", "has_sig": false, "md5_digest": "a461c3401897b8e5d1d6ed12a2983959", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17964, "upload_time": "2018-02-08T13:46:18", "url": "https://files.pythonhosted.org/packages/69/05/93d4ddf423cd147c46b4d80d77fc7b0f5dd1d07cbec91694875a0b5454cb/django-modelsdoc-0.1.9.tar.gz" } ] }