restless

A lightweight REST miniframework for Python.

Works great with Django, Flask, Pyramid & Tornado, 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.4+ (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

• Restless Tutorial
  • Why Restless?
  • Installation
  • Getting Started
  • About Resources
  • The Existing Setup
  • Creating A Resource
  • Hooking Up The URLs
  • Testing the API
  • Creating/Updating/Deleting Data
  • Testing the API, Round 2
  • Error Handling
  • Authentication
  • Testing the API, Round 3
  • Conclusion
  • Bonus: Flask Support
• Philosophy Behind Restless
  • Pithy Statements
• Extending Restless
  • Custom Endpoints
  • Customizing Data Output
  • Data Validation
  • Alternative Serialization

• Cookbook
• Contributing
• Security

API Reference

• Constants
  • restless.constants
• Data
  • restless.data
    • Data
• Exceptions
  • restless.exceptions
    • BadRequest
      • BadRequest.msg
      • BadRequest.status
    • Conflict
      • Conflict.msg
      • Conflict.status
    • ExpectationFailed
      • ExpectationFailed.msg
      • ExpectationFailed.status
    • FailedDependency
      • FailedDependency.msg
      • FailedDependency.status
    • Forbidden
      • Forbidden.msg
      • Forbidden.status
    • Gone
      • Gone.msg
      • Gone.status
    • HttpError
      • HttpError.msg
      • HttpError.status
    • IAmATeapot
      • IAmATeapot.msg
      • IAmATeapot.status
    • Locked
      • Locked.msg
      • Locked.status
    • MethodNotAllowed
      • MethodNotAllowed.msg
      • MethodNotAllowed.status
    • MethodNotImplemented
      • MethodNotImplemented.msg
      • MethodNotImplemented.status
    • NotAcceptable
      • NotAcceptable.msg
      • NotAcceptable.status
    • NotFound
      • NotFound.msg
      • NotFound.status
    • PreconditionFailed
      • PreconditionFailed.msg
      • PreconditionFailed.status
    • RestlessError
    • TooManyRequests
      • TooManyRequests.msg
      • TooManyRequests.status
    • Unauthorized
      • Unauthorized.msg
      • Unauthorized.status
    • Unavailable
      • Unavailable.msg
      • Unavailable.status
    • UnavailableForLegalReasons
      • UnavailableForLegalReasons.msg
      • UnavailableForLegalReasons.status
    • UnprocessableEntity
      • UnprocessableEntity.msg
      • UnprocessableEntity.status
    • UnsupportedMediaType
      • UnsupportedMediaType.msg
      • UnsupportedMediaType.status
• Preparers
  • restless.preparers
    • CollectionSubPreparer
      • CollectionSubPreparer.prepare()
    • FieldsPreparer
      • FieldsPreparer.lookup_data()
      • FieldsPreparer.prepare()
    • Preparer
      • Preparer.prepare()
    • SubPreparer
      • SubPreparer.get_inner_data()
      • SubPreparer.prepare()
• Resources
  • restless.resources
    • Resource
      • Resource.as_detail()
      • Resource.as_list()
      • Resource.as_view()
      • Resource.bubble_exceptions()
      • Resource.build_error()
      • Resource.build_response()
      • Resource.create()
      • Resource.create_detail()
      • Resource.delete()
      • Resource.delete_list()
      • Resource.deserialize()
      • Resource.deserialize_detail()
      • Resource.deserialize_list()
      • Resource.detail()
      • Resource.handle()
      • Resource.handle_error()
      • Resource.http_methods
      • Resource.is_authenticated()
      • Resource.is_debug()
      • Resource.list()
      • Resource.prepare()
      • Resource.preparer
      • Resource.request_body()
      • Resource.request_method()
      • Resource.serialize()
      • Resource.serialize_detail()
      • Resource.serialize_list()
      • Resource.serializer
      • Resource.status_map
      • Resource.update()
      • Resource.update_list()
      • Resource.wrap_list_response()
    • skip_prepare()
  • restless.dj
    • DjangoResource
      • DjangoResource.as_detail()
      • DjangoResource.as_list()
      • DjangoResource.build_error()
      • DjangoResource.build_response()
      • DjangoResource.build_url_name()
      • DjangoResource.is_debug()
      • DjangoResource.serialize_list()
      • DjangoResource.urls()
      • DjangoResource.wrap_list_response()
  • restless.fl
    • FlaskResource
      • FlaskResource.add_url_rules()
      • FlaskResource.as_detail()
      • FlaskResource.as_list()
      • FlaskResource.build_endpoint_name()
      • FlaskResource.build_response()
      • FlaskResource.is_debug()
      • FlaskResource.request_body()
  • restless.pyr
    • PyramidResource
      • PyramidResource.add_views()
      • PyramidResource.as_detail()
      • PyramidResource.as_list()
      • PyramidResource.build_response()
      • PyramidResource.build_routename()
  • restless.it
  • restless.tnd
    • TornadoResource
      • TornadoResource._request_handler_base_
      • TornadoResource.application
      • TornadoResource.as_detail()
      • TornadoResource.as_list()
      • TornadoResource.r_handler
      • TornadoResource.request
• Serializers
  • restless.serializers
    • JSONSerializer
      • JSONSerializer.deserialize()
      • JSONSerializer.serialize()
    • Serializer
      • Serializer.deserialize()
      • Serializer.serialize()
• Utils
  • restless.utils
    • MoreTypesJSONEncoder
      • MoreTypesJSONEncoder.default()
    • format_traceback()

Release Notes

• restless v2.0.3
• restless v2.0.2
• restless v2.0.1
• restless v2.0.0
• restless v1.4.0
• restless v1.3.0
• restless v1.2.0
• restless v1.1.0
• restless v1.0.0

Indices and tables

• Index

• Module Index

• Search Page