Builds Reusable Objects for Consuming Web APIs.
Works with Requests, asyncio, and Twisted.
Inspired by Retrofit.
A Quick Walkthrough, with GitHub API v3
Uplink turns your HTTP API into a Python class.
from uplink import Consumer, get, headers, Path, Query
class GitHub(Consumer):
@get("users/{user}/repos")
def get_repos(self, user: Path, sort_by: Query("sort")):
"""Retrieves the user's public repositories."""Build an instance to interact with the webservice.
github = GitHub(base_url="https://api.github.com/")Then, executing an HTTP request is as simply as invoking a method.
repos = github.get_repos("octocat", sort_by="created")The returned object is a friendly requests.Response:
print(repos.json())
# Output: [{'id': 64778136, 'name': 'linguist', ...For sending non-blocking requests, Uplink comes with support for aiohttp and twisted.
Use decorators and function annotations to describe the HTTP request:
URL parameter replacement and query parameter support
Convert response bodies into Python objects (e.g., using marshmallow or a custom converter)
JSON, URL-encoded, and multipart request body and file upload
Inject functions as middleware to apply custom response and error handling
Installation
uplink supports Python 2.7 & 3.3-3.7.
To install the latest stable release, you can use pip:
$ pip install -U uplink
If you are interested in the cutting-edge, preview the upcoming release with:
$ pip install https://github.com/prkumar/uplink/archive/master.zip
Extra! Extra!
Further, uplink has optional integrations and features. You can view a full list of available extras here.
When installing Uplink with pip, you can select extras using the format:
$ pip install -U uplink[extra1, extra2, ..., extraN]
For instance, to install aiohttp and marshmallow support:
$ pip install -U uplink[aiohttp, marshmallow]
Documentation
For more details, check out the documentation at https://uplink.readthedocs.io/.
Contributing
Want to report a bug, request a feature, or contribute code to Uplink? Checkout the Contribution Guide for where to start. Thank you for taking the time to improve an open source project 💜
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file uplink-0.5.5.tar.gz.
File metadata
- Download URL: uplink-0.5.5.tar.gz
- Upload date:
- Size: 31.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
73c84c7d4592ba8e73cbb5afea8539570267f6b37962b03603f5c0c7bfbe30d3
|
|
| MD5 |
ecf636d23ee673cc257af555f74faef8
|
|
| BLAKE2b-256 |
c6d64fc4370344e3ca697a2b6448bd878c089fcf3249515e0625703615f97f54
|
File details
Details for the file uplink-0.5.5-py2.py3-none-any.whl.
File metadata
- Download URL: uplink-0.5.5-py2.py3-none-any.whl
- Upload date:
- Size: 40.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
adb744219f6cb3176e1adefbfd858df1a0f9784919d9d95889d671ed786bd58b
|
|
| MD5 |
34a5e4c472d98c140d85bfc80a90b5c7
|
|
| BLAKE2b-256 |
6a58fdf773e039e5f45dd07b71c78d9865fcfc87cc1480eb95a55446e21c811b
|
