Tastypie is an webservice API framework for Django. It provides a convenient, yet powerful and highly customizable, abstraction for creating REST-style interfaces.
There are two primary ways of getting help. We have a mailing list hosted at Google (http://groups.google.com/group/django-tastypie/) and an IRC channel (#tastypie on irc.freenode.net) to get help, want to bounce idea or generally shoot the breeze.
Add tastypie to INSTALLED_APPS.
Create an api directory in your app with a bare __init__.py.
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']
In your root URLconf, add the following code (around where the admin code might be):
from tastypie.api import Api from my_app.api.resources import MyModelResource v1_api = Api(api_name='v1') v1_api.register(MyModelResource()) urlpatterns = patterns('', # ...more URLconf bits here... # Then add: (r'^api/', include(v1_api.urls)), )
Hit http://localhost:8000/api/v1/?format=json in your browser!
Tastypie requires the following modules. If you use Pip, you can install the necessary bits via the included requirements.txt:
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.
The easiest way to get setup to run Tastypie’s tests looks like:
$ git clone https://github.com/toastdriven/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 $ cd tests $ ./run_all_test.sh
Tastypie is maintained with all tests passing at all times. If you find a failure, please report it along with the versions of the installed software.
If you’re using Tastypie in a commercial environment, paid support is available from Toast Driven. Services offered include:
If you’re interested, please contact Daniel Lindsley (firstname.lastname@example.org).