{ "info": { "author": "Emmanouil Konstantinidis", "author_email": "manos@iamemmanouil.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5" ], "description": "# [DRF Docs](http://www.drfdocs.com/) [![travis][travis-image]][travis-url] [![codecov][codecov-image]][codecov-url] [![pypi][pypi-image]][pypi-url] [![slack][slack-image]][slack-url]\n\nDocument Web APIs made with Django Rest Framework. [View Demo](http://demo.drfdocs.com/)\n\n![DRFdocs](https://cloud.githubusercontent.com/assets/6333409/13193861/69e82aec-d778-11e5-95c4-77f4ef29e6e5.png)\n\n### Supports\n\n - Python (2.7, 3.3, 3.4, 3.5)\n - Django (1.8, 1.9)\n - Django Rest Framework (3+)\n\n\n### Documentation - Table of contents\n\n - [Installation](http://drfdocs.com/installation/)\n - [Settings](http://drfdocs.com/settings/)\n - [Extending the template](http://drfdocs.com/templates/)\n - [Live API Endpoints](http://drfdocs.com/live-api/)\n - [Contributing & Development](http://drfdocs.com/contributing/)\n - [Changelog](http://drfdocs.com/changelog/)\n\n\n### Development & Demo Project\nIf you are looking to develop this package with one of your own django projects:\n\n pyvenv env\n env/bin/pip install -r requirements.txt\n pip install -e ~/Projects/drf-docs/\n\nIf you want to use the demo app to work on this package:\nIncluded in this repo you can find the demo project(at `/demo`). It is a project with *Django* & *Django Rest Framework* that will allow you to work with this project. For more information on how you can set it up please check the [README.md](demo/README.md) of the demo project.\n\nFor more information visit [the docs](http://drfdocs.com/contributing/).\n\n### Installation\n\nInstall using pip:\n\n pip install drfdocs\n\nAdd 'rest_framework_docs' to your `INSTALLED_APPS` setting:\n\n INSTALLED_APPS = (\n ...\n 'rest_framework_docs',\n )\n\nFinally include the `rest_framework_docs` urls in your `urls.py`:\n\n urlpatterns = [\n ...\n url(r'^docs/', include('rest_framework_docs.urls')),\n ]\n\n\n### Settings\nYou can find detailed information about the package's settings at [the docs](http://drfdocs.com/settings/).\n\n REST_FRAMEWORK_DOCS = {\n 'HIDE_DOCS': True # Default: False\n }\n\n\n### Credits\n\nFirst of all thanks to the [Django](http://www.djangoproject.com/) core team and to all the contributors of [Django REST Framework](http://www.django-rest-framework.org/) for their amazing work. Also I would like to thank [Marc Gibbons](https://github.com/marcgibbons) for his *django-rest-framework-docs* project. Both projects share the same idea, it is just that Marc's is not maintained anymore and does not support DRF 3+ & Python 3.\n\n[travis-image]: https://travis-ci.org/ekonstantinidis/django-rest-framework-docs.svg?branch=master\n[travis-url]: https://travis-ci.org/ekonstantinidis/django-rest-framework-docs\n\n[pypi-image]: https://badge.fury.io/py/drfdocs.svg\n[pypi-url]: https://pypi.python.org/pypi/drfdocs/\n\n[codecov-image]: https://codecov.io/github/ekonstantinidis/django-rest-framework-docs/coverage.svg?branch=master\n[codecov-url]:https://codecov.io/github/ekonstantinidis/django-rest-framework-docs?branch=master\n\n[slack-image]: https://img.shields.io/badge/slack-pythondev/drfdocs-e01563.svg\n[slack-url]: https://pythondev.slack.com", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://www.drfdocs.com", "keywords": null, "license": "BSD", "maintainer": null, "maintainer_email": null, "name": "drfdocs", "package_url": "https://pypi.org/project/drfdocs/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/drfdocs/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://www.drfdocs.com" }, "release_url": "https://pypi.org/project/drfdocs/0.0.11/", "requires_dist": null, "requires_python": null, "summary": "Documentation for Web APIs made with Django Rest Framework.", "version": "0.0.11" }, "last_serial": 5520908, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "84c4c24bda3626883cd0a5ebf14eff88", "sha256": "fac74a6013b03d42956f99520f850243542d25fb0eed23913087ebed859c3f0a" }, "downloads": -1, "filename": "drfdocs-0.0.1.tar.gz", "has_sig": false, "md5_digest": "84c4c24bda3626883cd0a5ebf14eff88", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 484874, "upload_time": "2015-12-18T20:17:58", "url": "https://files.pythonhosted.org/packages/5a/4b/353ec6c3bc503552e58d5775927d5fcbf679c65683230cb6752fa173b9db/drfdocs-0.0.1.tar.gz" } ], "0.0.10": [ { "comment_text": "", "digests": { "md5": "fee8d8d997fecc2bbd6f4e9af02082a7", "sha256": "6312d143220b0332a91ef201e29a73fdc4a6da4b4a4ac43092410255164a3dd5" }, "downloads": -1, "filename": "drfdocs-0.0.10.tar.gz", "has_sig": false, "md5_digest": "fee8d8d997fecc2bbd6f4e9af02082a7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 770611, "upload_time": "2016-05-26T19:52:41", "url": "https://files.pythonhosted.org/packages/b5/cc/457ba95830ff9ac3d39bf3de888ceb92bee5c9a819d1f45433be28e421b8/drfdocs-0.0.10.tar.gz" } ], "0.0.11": [ { "comment_text": "", "digests": { "md5": "ae42aba1e598ac110de74bdad0f3d3f4", "sha256": "a94d63d714aa2796d85b695a665b17092260ab2447b9aed7453bf914a0056e1e" }, "downloads": -1, "filename": "drfdocs-0.0.11.tar.gz", "has_sig": false, "md5_digest": "ae42aba1e598ac110de74bdad0f3d3f4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 771078, "upload_time": "2016-06-04T16:32:14", "url": "https://files.pythonhosted.org/packages/e5/9e/3a9aa6908ad7bd95b46f7fe05256681f4101de9a7769b6928159a986ef61/drfdocs-0.0.11.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "d7af483f46a661a6f2474f0c1a1850fd", "sha256": "c7ad8ce37f0878a8c85ddd098ef03acd536ce5bf02f280a766fb65c82744f979" }, "downloads": -1, "filename": "drfdocs-0.0.2.tar.gz", "has_sig": false, "md5_digest": "d7af483f46a661a6f2474f0c1a1850fd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 485333, "upload_time": "2015-12-18T22:49:44", "url": "https://files.pythonhosted.org/packages/64/87/0c59366d3a7a79e461459e9f61b2ca952c4e5edb0251a2deac5020b6d491/drfdocs-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "742c4f65579d77884c75cb034b61450b", "sha256": "13357dda32ad30de5a0002c714d897cc5ba286bbc8d8d67e72e3f9f48ff0fa36" }, "downloads": -1, "filename": "drfdocs-0.0.3.tar.gz", "has_sig": false, "md5_digest": "742c4f65579d77884c75cb034b61450b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 714551, "upload_time": "2015-12-20T21:11:43", "url": "https://files.pythonhosted.org/packages/c9/67/b1fffb0dbbdb6427cb8abe4397181f56dfed8973da8be01f8393b328e5ab/drfdocs-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "74c0d76068f1a303f068358ed3d2da8b", "sha256": "8719efe01433c63020fb3cea11f118363b5cf571c06182585f88890ff034c3ed" }, "downloads": -1, "filename": "drfdocs-0.0.4.tar.gz", "has_sig": false, "md5_digest": "74c0d76068f1a303f068358ed3d2da8b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 663243, "upload_time": "2015-12-20T23:23:10", "url": "https://files.pythonhosted.org/packages/0b/f9/002629c90c28c489c040c693257346b63fb1dcae07e6b86f57d59d1779d9/drfdocs-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "a990803c93a6a061b78cbf1a49d022aa", "sha256": "cf515ff1864249b39a65e0d7c3048044a58b22a21998dcf47a5f395b7ab4b875" }, "downloads": -1, "filename": "drfdocs-0.0.5.tar.gz", "has_sig": false, "md5_digest": "a990803c93a6a061b78cbf1a49d022aa", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 660626, "upload_time": "2015-12-21T15:28:38", "url": "https://files.pythonhosted.org/packages/db/5f/7c2c2062f3ee8132bc5cf135b4282e806b88f7ba4cb48a8c46f3b60cf4cc/drfdocs-0.0.5.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "131895494980849f787d189cb642eb18", "sha256": "35e77f2608a722b46e62f298ea9811b8b3527d901b6ebd8738f89b9e3f48f083" }, "downloads": -1, "filename": "drfdocs-0.0.6.tar.gz", "has_sig": false, "md5_digest": "131895494980849f787d189cb642eb18", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 770121, "upload_time": "2016-01-23T22:11:11", "url": "https://files.pythonhosted.org/packages/de/3b/e4d5512786dbee10d7230c84e18e66e9788347c7424d00c5b3e8096a6efe/drfdocs-0.0.6.tar.gz" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "84a2d0a020a32bd11b5253f6abc3ca6a", "sha256": "2845831f156b394d0d74c689f3142583edba81030c17edf1bfb46adc30c2be13" }, "downloads": -1, "filename": "drfdocs-0.0.7.tar.gz", "has_sig": false, "md5_digest": "84a2d0a020a32bd11b5253f6abc3ca6a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 770317, "upload_time": "2016-02-25T22:12:40", "url": "https://files.pythonhosted.org/packages/ed/3c/9c83f852dd516c9040cc8ec21a8e7613a48db937f2a2fda41065c7807f15/drfdocs-0.0.7.tar.gz" } ], "0.0.9": [ { "comment_text": "", "digests": { "md5": "37216e1c2e72b330c7e0d3d6de41cbf3", "sha256": "56849b7dd27bb45fcbff15b2630ce576e16a97f750532527325cd5517c36f5f9" }, "downloads": -1, "filename": "drfdocs-0.0.9.tar.gz", "has_sig": false, "md5_digest": "37216e1c2e72b330c7e0d3d6de41cbf3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 770372, "upload_time": "2016-03-24T23:45:13", "url": "https://files.pythonhosted.org/packages/21/4e/67e513521bf7a6dca3382bcd331bf692703e75212f6938a32c1b6239ceed/drfdocs-0.0.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ae42aba1e598ac110de74bdad0f3d3f4", "sha256": "a94d63d714aa2796d85b695a665b17092260ab2447b9aed7453bf914a0056e1e" }, "downloads": -1, "filename": "drfdocs-0.0.11.tar.gz", "has_sig": false, "md5_digest": "ae42aba1e598ac110de74bdad0f3d3f4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 771078, "upload_time": "2016-06-04T16:32:14", "url": "https://files.pythonhosted.org/packages/e5/9e/3a9aa6908ad7bd95b46f7fe05256681f4101de9a7769b6928159a986ef61/drfdocs-0.0.11.tar.gz" } ] }