Creating delicious APIs for Django apps since 2010. v1.0.0-beta
Python Shell
Pull request Compare This branch is 44 commits ahead, 387 commits behind django-tastypie:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
tastypie
tests
.gitignore
.travis.yml
.venv
AUTHORS
BACKWARDS-INCOMPATIBLE.txt
CONTRIBUTING
LICENSE
MANIFEST.in
README.rst
TODO
requirements.txt
setup.cfg
setup.py
tox.ini

README.rst

dev branch of this fork of django-tastypie includes all these pull requests:

  • GH-525 Speeding up PUTs and PATCHs
  • GH-534 (merged) Query terms are now a set in Django development
  • GH-535 Django dev JSONEncoder is now based on json
  • GH-537 Removing the Manager dependency in ToManyField.dehydrate()
  • GH-547 PATCH returning an HttpResponse
  • GH-589 Fixing partial PUTS on resources with m2m relations
  • GH-593 (merged) Support for X-HTTP-Method-Override
  • GH-615 Avoiding PUT/POST to rebound data
  • GH-617 Raise InvalidFilter on unlisted model field
  • GH-624 Raising an error when a PUT or POST includes an unlisted field
  • GH-658 (merged) Adding tests for obj_update with identifiers
  • GH-659 Refactored obj_update with identifiers (Performance improvement)

You can see updated differences between toastdriven/django-tastypie@master vs twoapart/django-tastypie@dev here: https://github.com/TwoApart/django-tastypie/compare/toastdriven:master...dev

django-tastypie

Creating delicious APIs for Django apps since 2010.

Currently in beta (v0.11.1-dev) but being used actively in production on several sites.

Requirements

Core

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.defaults import *
from tastypie.api import Api
from myapp.api import EntryResource

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

urlpatterns = patterns('',
    # The normal jazz here then...
    (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 http://django-tastypie.readthedocs.org/.

Why Tastypie?

There are other, better known 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).
  • You want to support my perceived NIH syndrome, which is less about NIH and more about trying to help out friends/coworkers.

Reference Material

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.