{ "info": { "author": "Ocavue", "author_email": "ocavue@gmail.conm", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Programming Language :: Python :: 3" ], "description": "# django-doc-view: The simplest way to document your Django APIs\n\n[![license: MIT](https://img.shields.io/github/license/ocavue/django-doc-view.svg)](https://github.com/ocavue/django-doc-view/blob/master/LICENSE)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n[![PyPI](https://img.shields.io/pypi/v/django-doc-view.svg)](https://pypi.org/project/django-doc-view)\n\n`django-doc-view` find view's docsting and output them in shell after formatting.\n\n## Installation\n\n```bash\npip3 install django-doc-view\n```\n\n## Base Usage\n\nAdd `django_doc_view` to your INSTALLED_APPS setting:\n\n```python\n# settings.py\n\nINSTALLED_APPS = (\n ...\n 'django_doc_view'\n)\n```\n\nThen you can get the result by doc_view command:\n\n```bash\npython3 manage.py doc_view\n```\n\n## Example\n\n```python\n\ndef index(request):\n \"\"\"\n A example of Function-based view\n \"\"\"\n return HttpResponse(\"Hello, world. You're at the polls index.\")\n\n\nclass User(View):\n \"\"\"\n A example of Class-based view\n\n method:\n get\n request:\n id\n \"\"\"\n\n def get(self, request, *args, **kwargs):\n ...\n```\n\n```bash\n\n$ python3 manage.py doc_view\n\n## polls/\n\n A example of Function-based view\n\n## polls/user\n\n A example of Class-based view\n\n method:\n get\n request:\n id\n\n```\n\nYou can find a runnable example from [here](https://github.com/ocavue/django-doc-view-emample).", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ocavue/django-doc-view", "keywords": "django,api,view,document,doc", "license": "MIT License", "maintainer": "", "maintainer_email": "", "name": "django-doc-view", "package_url": "https://pypi.org/project/django-doc-view/", "platform": "any", "project_url": "https://pypi.org/project/django-doc-view/", "project_urls": { "Homepage": "https://github.com/ocavue/django-doc-view" }, "release_url": "https://pypi.org/project/django-doc-view/0.1.3/", "requires_dist": null, "requires_python": "", "summary": "The simplest way to document your Django APIs", "version": "0.1.3" }, "last_serial": 3790651, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "43888654e6687aeb1f92770427df65a0", "sha256": "c705fa72ae305838bcb75984e3c4263b55f03bc7e454198aa2d2c1be9adf03aa" }, "downloads": -1, "filename": "django_doc_view-0.1.0.tar.gz", "has_sig": false, "md5_digest": "43888654e6687aeb1f92770427df65a0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2074, "upload_time": "2018-03-05T01:40:19", "url": "https://files.pythonhosted.org/packages/fb/0f/87a3e4292e898673ad385cf442e3b710621e36de70b3cf60a068706b2562/django_doc_view-0.1.0.tar.gz" } ], "0.1.1": [], "0.1.2": [ { "comment_text": "", "digests": { "md5": "dbd4b7a1a6eea05a493c6ebba213ee34", "sha256": "676b8f694455136a0ca3dea20d3d032f29fa824b09136efb9b10a480a068bb4a" }, "downloads": -1, "filename": "django_doc_view-0.1.2.tar.gz", "has_sig": false, "md5_digest": "dbd4b7a1a6eea05a493c6ebba213ee34", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3140, "upload_time": "2018-04-09T05:35:14", "url": "https://files.pythonhosted.org/packages/66/e5/7c2399a0f15f8f972f8f82bd7213892f34be720946d88fff8da46b9c9a32/django_doc_view-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "e0674a67999ca43020a26baeebaf0f0b", "sha256": "bb2fd15fbac484af9d93636184cf5e209288b18430455da2efeb33e2f122f832" }, "downloads": -1, "filename": "django_doc_view-0.1.3.tar.gz", "has_sig": false, "md5_digest": "e0674a67999ca43020a26baeebaf0f0b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3159, "upload_time": "2018-04-23T02:49:07", "url": "https://files.pythonhosted.org/packages/d5/85/7b7f35a75163373cd118ec6365f7f90ad95d15e446f4e060d8762d0e5c7b/django_doc_view-0.1.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e0674a67999ca43020a26baeebaf0f0b", "sha256": "bb2fd15fbac484af9d93636184cf5e209288b18430455da2efeb33e2f122f832" }, "downloads": -1, "filename": "django_doc_view-0.1.3.tar.gz", "has_sig": false, "md5_digest": "e0674a67999ca43020a26baeebaf0f0b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3159, "upload_time": "2018-04-23T02:49:07", "url": "https://files.pythonhosted.org/packages/d5/85/7b7f35a75163373cd118ec6365f7f90ad95d15e446f4e060d8762d0e5c7b/django_doc_view-0.1.3.tar.gz" } ] }