Uplink 📡¶

A Declarative HTTP Client for Python. Inspired by Retrofit.

Note

Uplink is in beta development. The public API is still evolving, but we expect most changes to be backwards compatible at this point.

Uplink turns your HTTP API into a Python class.

from uplink import Consumer, get, Path, Query


class GitHub(Consumer):
    """A Python Client for the GitHub API."""

    @get("users/{user}/repos")
    def get_repos(self, user: Path, sort_by: Query("sort")):
       """Get 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(user="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 (example).

Features¶

Quickly Define Structured API Clients
- Use decorators and type hints to describe each HTTP request
- JSON, URL-encoded, and multipart request body and file upload
- URL parameter replacement, request headers, and query parameter support
Bring Your Own HTTP Library
- Non-blocking I/O support for Aiohttp and Twisted
- Supply your own session (e.g., requests.Session) for greater control
Easy and Transparent Deserialization/Serialization
- Define custom converters for your own objects
- Support for marshmallow schemas and handling collections (e.g., list of Users)
- Support for pydantic models and handling collections (e.g., list of Repos)
Extendable
- Install optional plugins for additional features (e.g., protobuf support)
- Compose custom response and error handling functions as middleware
Authentication
- Built-in support for Basic Authentication
- Use existing auth libraries for supported clients (e.g., requests-oauthlib)

Uplink officially supports Python 2.7 & 3.5+.

Note

Python 2.7 suport will be removed in v0.10.0.

User Testimonials¶

Michael Kennedy (@mkennedy), host of Talk Python and Python Bytes podcasts-

Of course our first reaction when consuming HTTP resources in Python is to reach for Requests. But for structured APIs, we often want more than ad-hoc calls to Requests. We want a client-side API for our apps. Uplink is the quickest and simplest way to build just that client-side API. Highly recommended.

Or Carmi (@liiight), notifiers maintainer-

Uplink’s intelligent usage of decorators and typing leverages the most pythonic features in an elegant and dynamic way. If you need to create an API abstraction layer, there is really no reason to look elsewhere.

User Manual¶

Follow this guide to get up and running with Uplink.

API Reference¶

This guide details the classes and methods in Uplink’s public API.

Uplink

Useful Links

Table of Contents

Uplink 📡¶

Features¶

User Testimonials¶

User Manual¶

API Reference¶

Miscellaneous¶