aio-apiclient -- Async helper to work with HTTP APIs
- 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
- python >= 3.7
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]
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 JSON
Slack 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
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, ...)
# ...
)
The api client support graceful shutdown. Run await client.shutdown() when you are finishing your app (not necessary).
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, options
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/aio-apiclient/issues
Development of the project happens at: https://github.com/klen/aio-apiclient
Licensed under a MIT license.