Metadata-Version: 1.1
Name: drf-swagger-customization
Version: 0.1.1
Summary: This is a django app which you can modify and improve your autogenerated swagger documentation from your drf API.
Home-page: https://github.com/androiz/drf-swagger-customization
Author: Andres Rojano Ruiz
Author-email: androiz10@gmail.com
License: MIT
Description: =============================
        drf-swagger-customization
        =============================
        
        .. image:: https://badge.fury.io/py/drf-swagger-customization.svg
            :target: https://badge.fury.io/py/drf-swagger-customization
        
        .. image:: https://travis-ci.org/androiz/drf-swagger-customization.svg?branch=master
            :target: https://travis-ci.org/androiz/drf-swagger-customization
        
        .. image:: https://codecov.io/gh/androiz/drf-swagger-customization/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/androiz/drf-swagger-customization
        
        This is a django app which you can modify and improve your autogenerated swagger documentation from your drf API.
        
        Documentation
        -------------
        
        The full documentation is at https://drf-swagger-customization.readthedocs.io.
        
        Quickstart
        ----------
        
        Install drf-swagger-customization::
        
            pip install drf-swagger-customization
        
        Add it to your `INSTALLED_APPS`:
        
        .. code-block:: python
        
            INSTALLED_APPS = (
                ...
                'DrfSwaggerCustomizationConfig',
                ...
            )
        
        Add these global variables to your settings.py:
        
        .. code-block:: python
        
            EXTENSION_PATH = os.path.join(PROJECT_DIR, 'docs/doc_extension.json') # Path to your extension file
            EXTERNAL_DOC_FOLDER = os.path.join(PROJECT_DIR, 'docs/external/') # Path to your external documentation folder
        
        
        Add drf-swagger-customization's URL patterns:
        
        .. code-block:: python
        
            from drf_swagger_customization.views import get_swagger_view
        
            schema_view = get_swagger_view(title='Pastebin API')
        
            urlpatterns = [
                ...
                url(r'^docs/$', schema_view),
                ...
            ]
        
        Features
        --------
        
        * TODO
        
        Credits
        -------
        
        Tools used in rendering this package:
        
        *  Cookiecutter_
        *  `cookiecutter-djangopackage`_
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage
        
        
        
        
        History
        -------
        
        0.1.1 (2017-05-25)
        ++++++++++++++++++
        
        * Fix in methods add, update and remove documentation.
        
        0.1.0 (2017-05-24)
        ++++++++++++++++++
        
        * First release on PyPI.
        
Keywords: drf-swagger-customization
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Framework :: Django :: 1.10
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
