Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
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.


pip install django-tastypie-simple-api-doc


First, add this to installed app and django_markup (we use this package to format classes docstrings).


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

API_OBJECT_LOCATION = "app.module.object_name"

In my test project 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 collectstatic

And this is it. :)

This is a work in progress but it can be already used in your projects. So, stay tuned. Feel free to contribute to get this app way more better. =D

Release History

History Node


This version
History Node


History Node


History Node


History Node


History Node


History Node


History Node


Download Files

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

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
(1.2 MB) Copy SHA256 Hash SHA256
Source None Mar 8, 2016

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Kabu Creative Kabu Creative UX & Design Google Google Cloud Servers Fastly Fastly CDN StatusPage StatusPage Statuspage DigiCert DigiCert EV Certificate