Metadata-Version: 2.0
Name: drf-swagger-extras
Version: 0.1.0.dev1
Summary: Django REST Framework extras for better Swagger/OpenAPI self-documentation
Home-page: https://github.com/ssaavedra/drf-swagger-extras
Author: Santiago Saavedra
Author-email: ssaavedra@gpul.org
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Documentation
Requires-Dist: coreapi (~=2.0)
Requires-Dist: djangorestframework (~=3.4)
Requires-Dist: openapi-codec (~=1.0)
Requires-Dist: six (~=1.10)
Provides-Extra: dev
Requires-Dist: pypandoc (~=1.2); extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage (~=4.2); extra == 'test'
Requires-Dist: pytest (~=3.0.2); extra == 'test'
Requires-Dist: tox (~=2.3); extra == 'test'

drf-swagger-extras
==================

|Build Status| |Coverage Report| |Requirements Status|

This package provides OpenAPI documentation Python decorators for Django
REST Framework APIViews.

This module provides a patched SchemaGenerator that enhances current
CoreAPI-based data that is grabbed by REST Framework with documentation
provided by decorators found in this package.

We allow documenting different response types and formats, and each HTTP
status code along with a schema and examples of the expected outcome.

We also provide optional API comments based on the function's
docstrings.

Usage
=====

~ to be filled ~

Contributing
============

This project uses the GitHub Flow approach for contributing, meaning
that we would really appreciate it if you would send patches as Pull
Requests in GitHub. If for any reason you prefer to send patches by
email, they are also welcome and will end up integrated here.

License
=======

This code is released under a MIT License.

.. |Build Status| image:: https://travis-ci.org/ssaavedra/drf-swagger-extras.svg?branch=master
   :target: https://travis-ci.org/ssaavedra/drf-swagger-extras
.. |Coverage Report| image:: https://codecov.io/gh/ssaavedra/drf-swagger-extras/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/ssaavedra/drf-swagger-extras
.. |Requirements Status| image:: https://requires.io/github/ssaavedra/drf-swagger-extras/requirements.svg?branch=master
   :target: https://requires.io/github/ssaavedra/drf-swagger-extras/requirements/?branch=master


