This project is a starting point for an API.

As of now, this is just a working set of REST API stubs, so the examples for GET, POST, PUT and DELETE requests are working and tested, but not very meaningful. More to come.

This project uses Cornice to build REST services.

Source: https://github.com/mozilla-services/cornice

Documentation: http://cornice.readthedocs.org/

The REST services are defined in src/c3s/api/views.py, including samples for GET, PUT, POST and DELETE. Tests are in src/c3s/api/tests/test_views.py.

Cornice offers a Sphinx extension to automagically create documentation from the docstrings etc. contained in the code.

The docs (using Sphinx) are in the subfolder docs/source and you can build them locally by calling bin/sphinx after having run buildout (see ci.sh).