restible 0.12.1

Python library to help building RESTful APIs

restible is a python library for creating consistent code for REST APIs across different frameworks. The main motivation was that the framework used is often dictated by requirements and I wanted to have a concise way of writing API endpoints no matter the underlying framework.

Useful links

• Docs

• Source Code

• CI Builds

Related libraries

• restible-flask

• restible-sqlalchemy

• restible-appengine

• restible-django

Installation

$ pip install restible

Contributing

Note

The library has a pretty good test coverage but not yet at 100%. A large part of the code is documented through docstrings but the general purpose docs are not written yet nor are any tutorials.

Cloning and setting up the development repo

$ git clone [e-mail]:novopl/restible.git
$ cd restible
$ virtualenv env
$ source ./env/bin/activate
$ pip install -r requirements.txt -r ops/devrequirements.txt
$ peltak git add-hooks

Running tests

Config: The types of tests are defined in pelconf.py and the pytest configuration is defined in ops/tools/pytest.ini.

$ peltak test

Linting

Config: The list of locations to lint is defined in pelconf.py and the linters configuration is defined in ops/tools/{pylint,pep8}.ini.

$ peltak lint

Generating docs

Config: The list of documented files and general configuration is in pelconf.py and the Sphinx configuration is defined in docs/conf.py.

$ peltak docs