A wrapper for REST APIs
About
Syndicate is a library for using HTTP based REST APIs. This provides a means to generically handle serialization (JSON, XML) and URI mapping as seen in many of the REST APIs published these days. Currently Tastypie APIs are the primary target but the system should be compossible enough to work with other APIs if they work roughly the same way.
Requirements
Requests (sync mode)
aiohttp (async mode)
Installation
python ./setup.py build python ./setup.py install
Compatibility
Python 3.4+
TODO
Unified authentication between HTTP adapters.
Documentation
Getting Started
Syndicate has two basic modes for communicating with an API, sync and async. The sync mode uses the ‘requests’ library as the HTTP adapter and the async mode uses aiohttp. An adapter can be provided by the user if they have their own backend.
In either mode, your interface is a ‘Service’ instance, which facilitates authentication, session management (via an adapter) and serialization.
Synchronous Examples
Creating a connnection
Instantiate a service class with some basic descriptions of the remote API to get a persistent connection.
import syndicate
bakery = syndicate.Service(uri='https://a.bakery.fake', urn='/api/v1/',
auth=('mrpresident', '1000xlight_points'))Simple GET
Fetch all the resources at https://a.bakery.fake/api/v1/cake/
for x in bakery.get('cake'):
print("Cake is food:", x)Adding a new resource
new_owl = bakery.post('cake', {
"type": "chuck_norris",
"name": "Round House",
"scovilles": 16000000001 # sorry resiniferatoxin
})Non CRUD methods
If your service has non CRUD methods, you can ask a service to “do” things directly. Let’s “BAKE /api/v1/cake/100” with some instructions in the content body.
bakery.do('bake', 'cake', 100, temp=420, time=3600)1 maintainer
Release files for syndicate 2.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| syndicate-2.1.2.tar.gz | 10.8 kB | Details |
Release files / syndicate-2.1.2.tar.gz
| Download URL | syndicate-2.1.2.tar.gz |
|---|---|
| Size | 10.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
74ab58a7e91ab601aa7d656dbd32b374679ca1f24ce8f6929d91c7255e2162e4
|
|
BLAKE2b-256 checksum How to use checksums |
18298f86546a02f0372fcae4aad4aefaf0ebff22548d6dc7d7d9a8ee04b0c47b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
