syndicate
===========
_*A wrapper for REST APIs*_
[](https://pypi.python.org/pypi/syndicate)
[](https://pypi.python.org/pypi/syndicate)
[](https://github.com/mayfield/syndicate/blob/master/CHANGELOG.md)
[](https://semaphoreci.com/mayfield/syndicate)
[](https://pypi.python.org/pypi/syndicate)
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.
```python
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/
```python
for x in bakery.get('cake'):
print("Cake is food:", x)
```
**Adding a new resource**
```python
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.
```python
bakery.do('bake', 'cake', 100, temp=420, time=3600)
```
===========
_*A wrapper for REST APIs*_
[](https://pypi.python.org/pypi/syndicate)
[](https://pypi.python.org/pypi/syndicate)
[](https://github.com/mayfield/syndicate/blob/master/CHANGELOG.md)
[](https://semaphoreci.com/mayfield/syndicate)
[](https://pypi.python.org/pypi/syndicate)
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.
```python
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/
```python
for x in bakery.get('cake'):
print("Cake is food:", x)
```
**Adding a new resource**
```python
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.
```python
bakery.do('bake', 'cake', 100, temp=420, time=3600)
```
1 maintainer
Metadata
1 maintainer
Release files for syndicate 3.0.0
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-3.0.0.tar.gz | 10.6 kB | Details |
Release files / syndicate-3.0.0.tar.gz
| Download URL | syndicate-3.0.0.tar.gz |
|---|---|
| Size | 10.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
37c7f7f69b1b11ca0b8195f78a2c81f15203c90b811e8e0b4de52dae93fead90
|
|
BLAKE2b-256 checksum How to use checksums |
6d76f0729e827e98f9def356221cfaf09f6707f846ea3812b7f913f1306ce83c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Python-urllib/3.7
|
