Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

A lightweight REST miniframework for Python.

Project description

DEPRECATED. We’re now part of the restless team, so development will continue there.


A fork of the restless lightweight REST miniframework for Python.

Documentation is at

Works great with Django, Flask, Pyramid, Tornado & Itty, but should be useful for many other Python web frameworks. Based on the lessons learned from Tastypie & other REST libraries.


  • Small, fast codebase
  • JSON output by default, but overridable
  • RESTful
  • Python 3.2+ (with shims to make broke-ass Python 2.6+ work)
  • Flexible


Things that will never be added to the core library - but plugins are encouraged!

  • Automatic ORM integration
  • Authorization (per-object or not)
  • Extensive filtering options
  • XML output
  • Metaclasses
  • Mixins


Creator @toastdriven had a very specific goal when building the original restless, and our goal is to respect it. Here it follows:

> Quite simply, I care about creating flexible & RESTful APIs. In building > Tastypie, I tried to create something extremely complete & comprehensive. > The result was writing a lot of hook methods (for easy extensibility) & a lot > of (perceived) bloat, as I tried to accommodate for everything people might > want/need in a flexible/overridable manner. > > But in reality, all I really ever personally want are the RESTful verbs, JSON > serialization & the ability of override behavior. > > This one is written for me, but maybe it’s useful to you.


Rather than try to build something that automatically does the typically correct thing within each of the views, it’s up to you to implement the bodies of various HTTP methods.

Example code:

# posts/
from django.contrib.auth.models import User

from import DjangoResource
from restkiss.preparers import FieldsPreparer

from posts.models import Post

class PostResource(DjangoResource):
    # Controls what data is included in the serialized output.
    preparer = FieldsPreparer(fields={
        'id': 'id',
        'title': 'title',
        'author': 'user.username',
        'body': 'content',
        'posted_on': 'posted_on',

    # GET /
    def list(self):
        return Post.objects.all()

    # GET /pk/
    def detail(self, pk):
        return Post.objects.get(id=pk)

    # POST /
    def create(self):
        return Post.objects.create(

    # PUT /pk/
    def update(self, pk):
            post = Post.objects.get(id=pk)
        except Post.DoesNotExist:
            post = Post()

        post.title =['title']
        post.user = User.objects.get(['author'])
        post.content =['body']
        return post

    # DELETE /pk/
    def delete(self, pk):

Hooking it up:

# api/
from django.conf.urls.default import url, include

from posts.api import PostResource

urlpatterns = [
    # The usual suspects, then...

    url(r'^api/posts/', include(PostResource.urls())),



Running the Tests

The test suite uses tox for simultaneous support of multiple versions of both Python and Django. The current versions of Python supported are:

  • CPython 2.7
  • CPython 3.4
  • CPython 3.5
  • PyPy (Python 2.7)
  • PyPy3 (Python 3.2)
  • PyPy3 beta (Python 3.3)

You just need to install the Python interpreters above and the tox package (available via pip), then run the tox command.

Project details

Download files

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

Files for restkiss, version 2.0.2
Filename, size File type Python version Upload date Hashes
Filename, size restkiss-2.0.2-py2.py3-none-any.whl (22.7 kB) File type Wheel Python version py2.py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page