Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

A Django app to generate a simple and automatic api documentation with Tastypie

Project Description

A Django app to generate a simple and automatic api documentation with Tastypie.

Installation

pip install django-tastypie-simple-api-doc

Usage

First, you need to tell me where is your Tastypie Api object that will be documented. Put it’s path in settings.py like this:

API_OBJECT_LOCATION = "app.module.object_name"

In mais test projetc was like this:

API_OBJECT_LOCATION = "project.urls.v1_api"

Got it? Now go to your urls module and goes like this:

from tastypie_api_doc.views import build_doc

urlpatterns = [
  ...
  url(r'^choose_your_url', build_doc),
]

And….We are almost there. Now, you need to “collect your static” if you know what I mean. :P

python manage.py collectstatic

And this is it. :)

For now, this django app just create a table with your Tastypie Endpoints. Feel free to contribute to get this app way more better.

Release History

Release History

History Node

0.5.0b1

History Node

0.4.0b1

History Node

0.3.0b1

History Node

0.2.0b1

This version
History Node

0.1.0b1

History Node

0.0.1b3

History Node

0.0.1b2

History Node

0.0.1b1

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
django-tastypie-simple-api-doc-0.1.0b1.tar.gz (1.2 MB) Copy SHA256 Checksum SHA256 Source Mar 3, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting