Skip to content
master
Go to file
Code

Latest commit

* Fix broken imports, some warnings

* Fix tests broken by changed single-quote escaping

* Loosen number of queries assertion to allow less than, as django 3.0 optimized away one query

* Update travis to run against django 3.0

* flake8

* Compat for contextmanager

* contextmanager didn't move, IDE was confused

* Build docs on 2.2 until gdal bug fixed

* Get debug output from travis about currently installed packages

* Fix less-than assertion

* Temporarily skip building docs under django 3.0

* Fix exclusion-by-env line

* Undo attempt to workaround GDAL; exclusion line isn't going to work

* Revert useless exclusion attempt

* Attempt updating gdal from PPA

* Try building on bionic

* Drop 3.5 support for Django 3.0

* Try other specifier for mod_spatialite

* Exclude python 3.5 from django 3.0 matrix

* Fix for force_str vs force_text under python 2

* Missing django for py35-docs

* Fix examples using render_to_response (deprecated) in docs

* Update docs, version, release notes
2700cdc

Git stats

Files

Permalink
Failed to load latest commit information.

README.rst

django-tastypie

Docs CI Code Coverage Version Downloads

Creating delicious APIs for Django apps since 2010.

Currently in beta but being used actively in production on several sites.

Requirements

Core

  • Python 2.7+ or Python 3.4+ (Whatever is supported by your version of Django)
  • Django 1.11, 2.2 (LTS releases) or Django 3.0 (latest release)
  • dateutil (http://labix.org/python-dateutil) >= 2.1

Format Support

Optional

What's It Look Like?

A basic example looks like:

# myapp/api.py
# ============
from tastypie.resources import ModelResource
from myapp.models import Entry


class EntryResource(ModelResource):
    class Meta:
        queryset = Entry.objects.all()


# urls.py
# =======
from django.conf.urls import url, include
from tastypie.api import Api
from myapp.api import EntryResource

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

urlpatterns = [
    # The normal jazz here then...
    url(r'^api/', include(v1_api.urls)),
]

That gets you a fully working, read-write API for the Entry model that supports all CRUD operations in a RESTful way. JSON/XML/YAML support is already there, and it's easy to add related data/authentication/caching.

You can find more in the documentation at https://django-tastypie.readthedocs.io/.

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.

Security

Tastypie is committed to providing a flexible and secure API, and was designed with many security features and options in mind. Due to the complex nature of APIs and the constant discovery of new attack vectors and vulnerabilities, no software is immune to security holes. We rely on our community to report and help us investigate security issues.

If you come across a security hole please do not open a Github issue. Instead, drop us an email at tastypie-security@googlegroups.com

We'll then work together to investigate and resolve the problem so we can announce a solution along with the vulnerability.

You can’t perform that action at this time.