Welcome to Tastypie!

Tastypie is a webservice API framework for Django. It provides a convenient, yet powerful and highly customizable, abstraction for creating REST-style interfaces.

Quick Start

  1. Add tastypie to INSTALLED_APPS.

  2. Create an api directory in your app with a bare __init__.py.

  3. Create an <my_app>/api/resources.py file and place the following in it:

    from tastypie.resources import ModelResource
from my_app.models import MyModel


class MyModelResource(ModelResource):
    class Meta:
        queryset = MyModel.objects.all()
        allowed_methods = ['get']

  4. In your root URLconf, add the following code (around where the admin code might be):

    from django.urls.conf import re_path, include
from tastypie.api import Api
from my_app.api.resources import MyModelResource

v1_api = Api(api_name='v1')
v1_api.register(MyModelResource())

urlpatterns = [
  # ...more URLconf bits here...
  # Then add:
  re_path(r'^api/', include(v1_api.urls)),
]

  5. Hit http://localhost:8000/api/v1/?format=json in your browser!

Requirements

Core

  • Python 3.6+, preferably 3.8+ (Whatever is supported by your version of Django)

  • Django 2.2, 3.2 (LTS releases) or Django 4.0 (latest release)

  • dateutil (http://labix.org/python-dateutil) >= 2.1

Format Support

Optional

Why Tastypie?

There are other API frameworks out there for Django. You need to assess the options available and decide for yourself. That said, here are some common reasons for tastypie.

  • You need an API that is RESTful and uses HTTP well.

  • You want to support deep relations.

  • You DON’T want to have to write your own serializer to make the output right.

  • You want an API framework that has little magic, very flexible and maps well to the problem domain.

  • You want/need XML serialization that is treated equally to JSON (and YAML is there too).

Reference Material

Getting Help

There are two primary ways of getting help.

  1. Go to StackOverflow and post a question with the tastypie tag.

  2. We have an IRC channel (#tastypie on irc.freenode.net) to get help, bounce an idea by us, or generally shoot the breeze.

Running The Tests

The easiest way to get setup to run Tastypie’s tests looks like:

$ git clone https://github.com/django-tastypie/django-tastypie.git
$ cd django-tastypie
$ virtualenv env
$ . env/bin/activate
$ ./env/bin/pip install -U -r requirements.txt

Then running the tests is as simple as:

# From the same directory as above:
$ ./env/bin/pip install -U -r tests/requirements.txt
$ ./env/bin/pip install tox
$ tox

Tastypie is maintained with all tests passing at all times for released dependencies. (At times tests may fail with development versions of Django. These will be noted as allowed failures in the .travis.yml file.) If you find a failure, please report it along with the versions of the installed software.