Finch: RESTful API consumer

Finch is an asynchronous RESTful API consumer for Python. Finch is focused on remove all of the boilerplate related to consuming http based APIs and provide a high level abstraction to develop API clients. Finch is released under the Apache 2 license, so you can fork, contribute and also report errors and suggestions to improve it.

Usage

To start consuming a REST API you first should define the resources you are going to consume. For resources modeling we use the booby data modeling library. So, for example, to get your repos from github.com you should define the Repo model and the Repos collection.

Tests

To run the Finch tests suite you should install the development requirements and run nosetests.

$ pip install -r requirements-devel.txt
$ nosetests tests/unit

Status

Finch is under active development and there is not a complete documentation yet. By the moment you can read the examples in this repository and read the tests, that are the most up to date documentation. Also I’m working on create a complete API client using Finch and create a good documentation.