Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
(Development stalled) Create somehow-RESTful HTTP APIs with Flask
Python
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
example
flask_toybox
tests
.gitignore
.travis.yml
LICENSE.txt
MANIFEST.in
README.rst
setup.py
tox.ini

README.rst

Flask-ToyBox

https://secure.travis-ci.org/drdaeman/flask-toybox.png?branch=master

Sorry, no documentation yet, this is totally pre-alpha quality.

I just needed something to implement somehow RESTful (or, to be precise, what I consider RESTful) API. I've looked around for a readily available solution, but didn't found anything that suited my needs and desires. So I've wrote a hopefully reusable library to do it.

The work is in progress, and API is unstable and subject to various changes.

See feature list below for main points about this library.

Features

What's implemented:

  • Extensible (de)serialization for both input and output, with HTTP content-type negotiation.
  • Handling of GET and PATCH requests (object retrieval and modification)
  • Relatively flexible field-level permissions. Could be always supplemented by TastyPie-like hydration/dehydration methods.
  • SQLAlchemy model and collection views support. Best used with Flask-SQLAlchemy.
  • Simple pagination helper (pagination using "Range" request header).
  • Built-in helper for filtering SQLAlchemy collections.

What's missing:

  • Better example.
  • Documentation. There are some docstrings in source code, but not much.
  • POST, PUT and DELETE requests (object creation and deletion).
  • Overriding negotiation using query string (i.e. ?format=json)
  • Nested resources.
  • Better test coverage.

Copyright

Copyright (c) 2012, Aleksey Zhukov.

Distributed under MIT (Expat) license. See LICENSE.txt for details.

Something went wrong with that request. Please try again.