It's a plugin for Muffin framework which provides support for external APIs
Project description
Muffin-APIClient – Its a plugin for Muffin framework which provides support for external APIs
Requirements
python >= 3.9
Installation
Muffin-APIClient should be installed using pip:
pip install muffin-apiclient
Usage
Initialize and setup the plugin:
import muffin
import muffin_apiclient
# Create Muffin Application
app = muffin.Application('example')
# Initialize the plugin
# As alternative: apiclient = muffin_apiclient.Plugin(app, **options)
apiclient = muffin_apiclient.Plugin()
apiclient.setup(app, root_url='https://api.github.com')Github API (https://developer.github.com/v4/):
github = muffin_apiclient.Plugin(app, name='github', root_url='https://api.github.com', defaults={
'headers': {
'Authorization': 'token OAUTH-TOKEN'
}
})
# Read information about the current repository
repo = await github.api.repos.klen['muffin-apiclient'].get()
print(repo) # dict parsed from Github Response JSONSlack API (https://api.slack.com/web):
slack = muffin_apiclient.Plugin(app, name='slack', root_url='https://slack.com/api', defaults={
'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
Options
Name |
Default value |
Desctiption |
root_url |
None |
Define general root URL for the client |
timeout |
None |
Define client timeout |
backend_type |
httpx |
APIClient backend (httpx|aiohttp) |
backend_options |
{} |
Backend options |
raise_for_status |
True |
Raise errors for HTTP statuses (300+) |
read_response_body |
True |
Read responses |
parse_response_body |
True |
Parse responses (load json, etc) |
client_defaults |
{} |
Default client values (headers, auth, etc) |
You are able to provide the options when you are initiliazing the plugin:
apiclient.setup(app, root_url='https://api.github.com')Or setup it inside Muffin.Application config using the APICLIENT_ prefix:
APICLIENT_ROOT_URL = 'https://api.github.com'Muffin.Application configuration options are case insensitive
Bug tracker
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/muffin-apiclient/issues
Contributing
Development of Muffin-APIClient happens at: https://github.com/klen/muffin-apiclient
Contributors
klen (Kirill Klenov)
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 muffin_apiclient-3.8.0.tar.gz.
File metadata
- Download URL: muffin_apiclient-3.8.0.tar.gz
- Upload date:
- Size: 4.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1024-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b44c3debc5c2734a3caca22bf8ae83c70c6b77cd9d554d98b7149790d856f510 |
|
| MD5 | 0108ee109acdd183864387b3c0cd057f |
|
| BLAKE2b-256 | 4165af87de308f3b31030281412d6a1d1d0257943914c9bf808f89f975a06844 |
File details
Details for the file muffin_apiclient-3.8.0-py3-none-any.whl.
File metadata
- Download URL: muffin_apiclient-3.8.0-py3-none-any.whl
- Upload date:
- Size: 4.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1024-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6b14a0c798e4ef8f5f5d2a0c80cd3666a1a7692509aabe0313a3a2f9ee80e35d |
|
| MD5 | 7145c58b783e59fa11d0923fc8b8a7b1 |
|
| BLAKE2b-256 | bd52e9656d3c344d6dce3e19ed3c0e38f890b18b20bee7f45d6ee0a0b6218dc7 |
