{ "info": { "author": "louielu", "author_email": "louie.lu@hopebaytech.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> **Contributors Wanted**: Do you like this project? Using it? Let's make it better!\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 'LOGIN_REQUIRED': True, # Default: True\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/manosim/django-rest-framework-docs.svg?branch=master\n[travis-url]: https://travis-ci.org/manosim/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/manosim/django-rest-framework-docs/coverage.svg?branch=master\n[codecov-url]:https://codecov.io/github/manosim/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": "https://louie.lu", "keywords": null, "license": "BSD", "maintainer": null, "maintainer_email": null, "name": "drfdocs-louielu", "package_url": "https://pypi.org/project/drfdocs-louielu/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/drfdocs-louielu/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://louie.lu" }, "release_url": "https://pypi.org/project/drfdocs-louielu/0.0.11/", "requires_dist": null, "requires_python": null, "summary": "patch for Documentation for Web APIs made with Django Rest Framework.", "version": "0.0.11" }, "last_serial": 2381285, "releases": { "0.0.11": [ { "comment_text": "", "digests": { "md5": "9e66e5e32c443264e247e1494a838d02", "sha256": "e4281697c6c199b7dedcdd385a87f5bad28d3120f7fcb0e2bdb7182c0d0e1a65" }, "downloads": -1, "filename": "drfdocs-louielu-0.0.11.tar.gz", "has_sig": false, "md5_digest": "9e66e5e32c443264e247e1494a838d02", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 773716, "upload_time": "2016-10-05T03:29:27", "url": "https://files.pythonhosted.org/packages/13/3b/8657f90a8023a802d9612c235d45cdb862d339f191da03a81d4576632001/drfdocs-louielu-0.0.11.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9e66e5e32c443264e247e1494a838d02", "sha256": "e4281697c6c199b7dedcdd385a87f5bad28d3120f7fcb0e2bdb7182c0d0e1a65" }, "downloads": -1, "filename": "drfdocs-louielu-0.0.11.tar.gz", "has_sig": false, "md5_digest": "9e66e5e32c443264e247e1494a838d02", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 773716, "upload_time": "2016-10-05T03:29:27", "url": "https://files.pythonhosted.org/packages/13/3b/8657f90a8023a802d9612c235d45cdb862d339f191da03a81d4576632001/drfdocs-louielu-0.0.11.tar.gz" } ] }