ServiceAPI, a base class for APIs which talk to a service, typically a web service via HTTP.
Project description
ServiceAPI, a base class for APIs which talk to a service, typically a web service via HTTP.
Latest release 20230703: Retry logic for requests.
An instance of a ServiceAPI embodies some basic features
that feel common to web based services:
- a notion of a login
- local state, an
SQLTagsfor data about entities of the service - downloads, if that is a thing, with
FSTagsfor file annotations
Class HTTPServiceAPI(ServiceAPI, cs.resources.MultiOpenMixin, cs.context.ContextManagerMixin)
HTTPServiceAPI base class for other APIs talking to HTTP services.
Subclasses must define:
API_BASE: the base URL of API calls. For example, thePlayOnAPIdefines this asf'https://{API_HOSTNAME}/v3/'.
Class RequestsNoAuth(requests.auth.AuthBase)
This is a special purpose subclass of requests.auth.AuthBase
to apply no authorisation at all.
This is for services with their own special purpose authorisation
and avoids things like automatic netrc based auth.
Class ServiceAPI(cs.resources.MultiOpenMixin, cs.context.ContextManagerMixin)
SewrviceAPI base class for other APIs talking to services.
Release Log
Release 20230703: Retry logic for requests.
Release 20230217: Initial release.
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 cs.service_api-20230703.tar.gz.
File metadata
- Download URL: cs.service_api-20230703.tar.gz
- Upload date:
- Size: 4.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 87c5adb73d73b758a73a5a478974e2b18f5e18c058f2c316ac99fbb4c9c21e7e |
|
| MD5 | f51ac4d1c9b0ca7c9b3fe32d2c4d8f0a |
|
| BLAKE2b-256 | eed1da238ec11f814af0ce2183f00b0875406eec70c39ffa6a3267acb6c6aec5 |
File details
Details for the file cs.service_api-20230703-py3-none-any.whl.
File metadata
- Download URL: cs.service_api-20230703-py3-none-any.whl
- Upload date:
- Size: 4.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 85bac8a742dd2449339bd1ccf7d571149d204daa7f59a19d12f1d6db2708d89d |
|
| MD5 | 0ff349a6670f46a40ac85c2d440b79b9 |
|
| BLAKE2b-256 | 471f9a1fbc333dbdb5b45c72d620593cac7182bb4e820c416fc2f81424e82d1b |
