Metadata-Version: 1.1
Name: drfdocs
Version: 0.0.3
Summary: Documentation for Web APIs made with Django Rest Framework.
Home-page: http://www.drfdocs.com
Author: Emmanouil Konstantinidis
Author-email: manos@iamemmanouil.com
License: BSD
Description: # [Django Rest Framework Docs](http://www.drfdocs.com/) [![travis][travis-image]][travis-url] [![codecov][codecov-image]][codecov-url] [![pypi][pypi-image]][pypi-url]
        
        Document Web APIs made with Django Rest Framework. [View Demo](http://demo.drfdocs.com/)
        
        ![DRFdocs](http://drfdocs.com/static/images/mockup.png)
        
        ### Supports
        
          - Python (2.7, 3.3, 3.4, 3.5)
          - Django (1.8, 1.9)
          - Django Rest Framework (3+)
        
        
        ### Documentation - Table of contents
        
          - [Installation](http://drfdocs.com/docs/installation/)
          - [Settings](http://drfdocs.com/docs/settings/)
          - [Extending the template](http://drfdocs.com/docs/templates/)
          - [Contributing & Development](http://drfdocs.com/docs/contributing/)
          - [Changelog](http://drfdocs.com/docs/changelog/)
        
        
        ### Development & Demo Project
        If you are looking to develop this package with one of your own django projects:
        
            pyvenv env
            env/bin/pip install -r requirements.txt
            pip install -e ~/Projects/drf-docs/
        
        If you want to use the demo app to work on this package:
        Included 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.
        
        For more information visit [the docs](http://drfdocs.com/docs/contributing/).
        
        ### Installation
        
        Install using pip:
        
            pip install drfdocs
        
        Add 'rest_framework_docs' to your `INSTALLED_APPS` setting:
        
            INSTALLED_APPS = (
                ...
                'rest_framework_docs',
            )
        
        Finally include the `rest_framework_docs` urls in your `urls.py`:
        
            urlpatterns = [
                ...
                url(r'^docs/', include('rest_framework_docs.urls')),
            ]
        
        
        ### Settings
        You can find detailed information about the package's settings at [the docs](http://drfdocs.com/docs/settings/).
        
            REST_FRAMEWORK_DOCS = {
                'HIDDEN': True  # Default: False
            }
        
        
        ### Credits
        
        First 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.
        
        [travis-image]: https://travis-ci.org/ekonstantinidis/django-rest-framework-docs.svg?branch=master
        [travis-url]: https://travis-ci.org/ekonstantinidis/django-rest-framework-docs
        
        [pypi-image]: https://badge.fury.io/py/drfdocs.svg
        [pypi-url]: https://pypi.python.org/pypi/drfdocs/
        
        [codecov-image]: https://codecov.io/github/ekonstantinidis/django-rest-framework-docs/coverage.svg?branch=master
        [codecov-url]:https://codecov.io/github/ekonstantinidis/django-rest-framework-docs?branch=master
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
