index.rst

restless

A lightweight REST miniframework for Python.

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.

Features

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

Anti-Features

(Things that will never be added...)

• Automatic ORM integration
• Authorization (per-object or not)
• Extensive filtering options
• XML output (though you can implement your own)
• Metaclasses
• Mixins
• HATEOAS

Topics

.. toctree::
   :maxdepth: 2

   tutorial
   philosophy

   extending

.. toctree::
   :maxdepth: 1

   cookbook

   contributing
   security

API Reference

.. toctree::
   :glob:

   reference/*

Release Notes

.. toctree::
   :maxdepth: 1

   releasenotes/v2.0.3
   releasenotes/v2.0.2
   releasenotes/v2.0.1
   releasenotes/v2.0.0
   releasenotes/v1.4.0
   releasenotes/v1.3.0
   releasenotes/v1.2.0
   releasenotes/v1.1.0
   releasenotes/v1.0.0

Indices and tables

• :ref:`genindex`
• :ref:`modindex`
• :ref:`search`