Skip to main content

HTTP for humanitarians.

Project description

image image image image image image image image image image image

Clients provide requests and httpx wrappers which encourage best practices, particularly always using Sessions to connect to the same host or api endpoint.

Usage

Typical requests usage is redundant and inefficient, by not taking advantage of connection pooling.

r = requests.get('https://api.github.com/user', headers={'authorization': token})
r = requests.get('https://api.github.com/user/repos', headers={'authorization': token})

Using sessions is the better approach, but more verbose and in practice requires manual url joining.

s = requests.Session()
s.headers['authorization'] = token
r = s.get('https://api.github.com/user')
r = s.get('https://api.github.com/user/repos')

Client

Clients make using sessions easier, with implicit url joining.

client = clients.Client('https://api.github.com/', headers={'authorization': token})
r = client.get('user')
r = client.get('user/repos')

Resource

Resources extend Clients to implicitly handle response content, with proper checking of status_code and content-type.

github = clients.Resource('https://api.github.com/', headers={'authorization': token})
for repo in github.get('user/repos', params={'visibility': 'public'}):
    ...

Resources also implement syntactic support for methods such as getattr and call, providing most of the benefits of custom clients as is.

for repo in github.user.repos(visibility='public'):
    ...

Being session based, Clients work seamlessly with other requests adapters, such as CacheControl. Asynchronous variants of all client types are provided in Python 3, using httpx instead of requests. Additional clients for RPC, GraphQL, and proxies also provided.

Installation

% pip install clients

Dependencies

  • requests >=2.4.2
  • httpx >=0.11 (if Python >=3.6)

Tests

100% branch coverage.

% pytest [--cov]

Roadmap

aiohttp has made several incompatible changes, including forbidding subclassing. So the async client has switched to httpx.

There are no interface changes to the async client itself, other than the different response object. In the future clients may switch to only httpx or requests3.

Changes

1.2

  • Python 3 required
  • httpx >=0.11 required

1.1

  • Async switched to httpx

1.0

  • Allow missing content-type
  • Oauth access tokens supported in authorization header

0.5

  • AsyncClient default params
  • Remote and AsyncRemote procedure calls
  • Graph and AsyncGraph execute GraphQL queries
  • Proxy and AsyncProxy clients

0.4

  • Asynchronous clients and resources

0.3

  • singleton decorator

0.2

  • Resource attribute upcasts back to a client
  • iter and download implement GET requests with streamed content
  • create implements POST request and returns Location header
  • update implements PATCH request with json params
  • __call__ implements GET request with params

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for clients, version 1.2
Filename, size File type Python version Upload date Hashes
Filename, size clients-1.2-py2.py3-none-any.whl (9.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size clients-1.2.tar.gz (18.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page