A Declarative HTTP Client for Python.
Project description
Python HTTP Made Expressive. Inspired by Retrofit.
A Quick Walkthrough, with GitHub API v3
Using decorators and function annotations, you can turn any plain old Python class into a self-describing consumer of your favorite HTTP webservice:
from uplink import *
# To register entities that are common to all API requests, you can
# decorate the enclosing class rather than each method separately:
@headers({"Accept": "application/vnd.github.v3.full+json"})
class GitHub(object):
@get("/users/{username}")
def get_user(self, username):
"""Get a single user."""
@json
@patch("/user")
def update_user(self, access_token: Query, **info: Body):
"""Update an authenticated user."""To construct a consumer instance, use the helper function uplink.build:
github = build(GitHub, base_url="https://api.github.com/")To access the GitHub API with this instance, we simply invoke any of the methods that we defined in the interface above. To illustrate, let’s update my GitHub profile bio:
response = github.update_user(oauth_token, bio="Beam me up, Scotty!").execute()Voila, update_user(...) seamlessly builds the request (using the decorators and annotations from the method’s definition), and execute() sends that synchronously over the network. Furthermore, the returned response is a requests.Response (documentation):
print(response.json()) # {u'disk_usage': 216141, u'private_gists': 0, ...In essence, Uplink delivers reusable and self-sufficient objects for accessing HTTP webservices, with minimal code and user pain ☺️.
Installation
uplink supports Python 2.7 & 3.3-3.7. To install the package, you can use pip:
$ pip install uplink
Documentation
For more details, check out the documentation at http://uplink.readthedocs.io/.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for uplink-0.1.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 86479d00ee48b4b2cd4efd1cbb7de2b6951d8dbbf32945750d02650cc2869b60 |
|
| MD5 | de4676045acb18872ba83db0ac75c899 |
|
| BLAKE2b-256 | 59d82b9aefccc96836d0a46b55951e5988fce33a3a82e6d3f58554524331dbc3 |
