chain-py 0.1.6

An expressive clean way to interact with RESTful APIs.

An expressive clean way to interact with REsTful APIs. It was inspired by zmallen’s pygraylog.

Chain is a small enhancement to the popular requests package. By referencing the endpoints as attributes to the client, it effectively “chains” the endpoints together, building the target url.

Chain is an attempt to make REsTful API clients look more like python objects, by removing the hardcoded URL strings in the code.

Chain uses the requests package as its http client, keeping its parameters and response objects. If you already use requests as your http client, then adopting chain would be easy.

Usage

Lets take for example this API:

# create a new client for the API
>>> import chain
>>> blogs = chain.Client('http://jsonplaceholder.typicode.com')

# if you want the posts:
>>> response = blogs.get.posts()

# the response is the response object from the requests package
>>> print response.json()

Numbers and special characters are also supported using dictionary notation

# Get the first post
>>> response = blogs.get.posts[1]()
>>> print response.json()

chain parameters are requests.requests parameters:

# parameters are the same as requests.requests parameters
>>> response = blogs.get.comments(params={'postId': '1'})
>>> print response.json()

>>> comment = {'postId': 1, 'id':501, 'name':'chain', 'email':'[e-mail]', 'body':'meh.'}
>>> response = blogs.post.comments(json=comment)

Installation

pip install chain-api

Testing

python setup.py test

Or:

tox

Compatibility

Works with Python version 2.7, 3.3, 3.4, 3.5 and 3.6

Licence

MIT licensed. Requests is licensed by the Apache License. See full LICENSE

Authors

chain was written by Anfernee Jervis.