2011-01-17 20:34:58 +03:00
|
|
|
FlyWheel Documentation
|
|
|
|
|
======================
|
|
|
|
|
|
|
|
|
|
This is the online documentation for FlyWheel - A REST framework for Django.
|
|
|
|
|
|
2011-01-24 21:59:23 +03:00
|
|
|
Some of FlyWheel's features:
|
|
|
|
|
|
2011-01-24 02:08:16 +03:00
|
|
|
* Clean, simple, class-based views for Resources.
|
2011-01-24 21:59:23 +03:00
|
|
|
* Support for ModelResources with nice default implementations and input validation.
|
|
|
|
|
* Automatically provides a browse-able self-documenting API.
|
|
|
|
|
* Pluggable Emitters, Parsers and Authenticators - Easy to customise.
|
|
|
|
|
* Content type negotiation using Accept headers.
|
|
|
|
|
* Optional support for forms as input validation.
|
|
|
|
|
* Modular architecture - Easy to extend and modify.
|
2011-01-24 02:08:16 +03:00
|
|
|
|
2011-01-28 20:42:57 +03:00
|
|
|
Installation & Setup
|
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
|
|
blah di blah
|
|
|
|
|
|
|
|
|
|
Getting Started
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
Blah di blah
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Examples
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
Blah blah blah, examples here.
|
|
|
|
|
|
|
|
|
|
Add a toctree for examples
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Library Reference
|
|
|
|
|
-----------------
|
|
|
|
|
|
2011-01-24 02:08:16 +03:00
|
|
|
.. toctree::
|
2011-01-28 20:42:57 +03:00
|
|
|
:maxdepth: 2
|
2011-01-24 02:08:16 +03:00
|
|
|
|
|
|
|
|
resource
|
|
|
|
|
modelresource
|
|
|
|
|
emitters
|
2011-01-26 11:58:09 +03:00
|
|
|
parsers
|
|
|
|
|
authenticators
|
2011-01-24 02:08:16 +03:00
|
|
|
response
|
|
|
|
|
|
|
|
|
|
|
2011-01-17 20:34:58 +03:00
|
|
|
Indices and tables
|
|
|
|
|
------------------
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`modindex`
|
|
|
|
|
* :ref:`search`
|
|
|
|
|
|
