Async helper to work with HTTP APIs
Project description
aio-apiclient – Async helper to work with HTTP APIs
Features
Convenient work with any HTTP API (especially with REST)
Supports httpx and aiohttp as backends to make requests
Very configurable and usable
An ability to parse responses automatically
Requirements
python >= 3.7
Installation
aio-apiclient should be installed using pip:
pip install aio-apiclient
Please note that aio-apiclient requires any of supported http backends (aiohttp, httpx) to be installed in order for it to work.
You may optionally install the requirements with the library:
# For httpx pip install aio-apiclient[httpx] # For aiohttp pip install aio-apiclient[aiohttp]
QuickStart
Github API (https://developer.github.com/v4/):
from apiclient import APIClient
# First available backend (aiohttp, httpx) will be used
client = APIClient('https://api.github.com', headers={
'Authorization': 'token OAUTH-TOKEN'
})
# Read information about the current repository
repo = await client.api.repos.klen['aio-apiclient'].get()
print(repo) # dict parsed from Github Response JSONSlack API (https://api.slack.com/web):
from apiclient import APIClient
client = APIClient('https://api.github.com', headers={
'Authorization': 'token OAUTH-TOKEN'
})
# Update current user status (we don't care about this response)
await client.api['users.profile.set'].post(json={
'profile': {
'status_text': 'working',
'status_emoji': ':computer:'
'status_expiration': 30,
}
}, read_response_body=False)And etc
Usage
Initialization
The Client initialization requires root URL for a required API.
from apiclient import APIClient
client = APIClient(
# Root URL for any API (required)
'https://api.github.com',
# Raise `client.Error` for any response with status code > 400
raise_for_status=True,
# Set to `False` if you only want to make a request and doesn't care about responses
read_response_body=True,
# Parse response's body content-type and return JSON/TEXT/Form data instead the response itself
# Set total timeout in seconds
timeout=10.0,
# Set backend type for making requests (apiclient.backends.BackendHTTPX,
# apiclient.backends.BackendAIOHTTP) by default first available would be
# choosen
backend_type=None,
# Default backend options to use with every request (headers, params, data, ...)
# ...
)App Shutdown
The api client support graceful shutdown. Run await client.shutdown() when you are finishing your app (not necessary).
Middlewares
You are able to dinamically change request params (method, url, other backend params) using middlewares.
import time
from apiclient import APIClient
client = APIClient('https://api.github.com')
@client.middleware
async def insert_timestamp_header(method, url, options):
options.setdefault('headers', {})
options['headers']['X-Timestamp'] = str(time.time())
return method, url, optionsBug tracker
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/aio-apiclient/issues
Contributing
Development of the project happens at: https://github.com/klen/aio-apiclient
License
Licensed under a MIT license.
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
File details
Details for the file aio-apiclient-1.6.2.tar.gz.
File metadata
- Download URL: aio-apiclient-1.6.2.tar.gz
- Upload date:
- Size: 7.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b9f53b7a386eb62e7b1f0f6f4f5577048c592391454bc470a9bcec10fe471880 |
|
| MD5 | 45929f281b0f999b0bca1f2cea840073 |
|
| BLAKE2b-256 | 0366eb6414ad162c4287a1c85fc6b75e5d636dd5deeb046445406fffaf3d3572 |
File details
Details for the file aio_apiclient-1.6.2-py3-none-any.whl.
File metadata
- Download URL: aio_apiclient-1.6.2-py3-none-any.whl
- Upload date:
- Size: 8.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f436aea197995e976846108ce12faedc340f2ae7f52f8873eb772dad98a7b59e |
|
| MD5 | 5df9b91c1d87e58dbd5021e60463f169 |
|
| BLAKE2b-256 | cc3d656099fec8a71bc4ea0a79b965bc9affda2b8c22abb3b3a0dcec5519d32e |
