drf-swaggify 0.1.2

A Django Rest Framework API documentation generator.

Overview

A Django Rest Framework API documentation generator.

Requirements

• Python 2.7

• Django 1.8

• Django REST Framework 3.2.2

Installation

Install using pip…

$ pip install drf-swaggify

Example

TODO: Write example.

Testing

Install testing requirements.

$ pip install -r requirements.txt

Run with runtests.

$ ./runtests.py

You can also use the excellent tox testing tool to run the tests against all supported versions of Python and Django. Install tox globally, and then simply run:

$ tox

Documentation

To build the documentation, you’ll need to install mkdocs.

$ pip install mkdocs

To preview the documentation:

$ mkdocs serve
Running at: http://127.0.0.1:8000/

To build the documentation:

$ mkdocs build