Skip to main content

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 20230217: Initial release.

An instance of a ServiceAPI embodies some basic features that feel common to web based services:

  • a notion of a login
  • local state, an SQLTags for data about entities of the service
  • downloads, if that is a thing, with FSTags for 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, the PlayOnAPI defines this as f'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 20230217: Initial release.

Project details


Download files

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

Source Distribution

cs.service_api-20230217.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

cs.service_api-20230217-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file cs.service_api-20230217.tar.gz.

File metadata

  • Download URL: cs.service_api-20230217.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for cs.service_api-20230217.tar.gz
Algorithm Hash digest
SHA256 74a420d228c49d0056abdb2acd39ba41d9e53ab31d00736c4e9b438669188212
MD5 3fdfb68362e3d7725a7c9d86dd10097c
BLAKE2b-256 ee7b20282d177bcb9f21e1d63b5fe181bfd76300457f6ecdebf73a1349ca07e5

See more details on using hashes here.

File details

Details for the file cs.service_api-20230217-py3-none-any.whl.

File metadata

File hashes

Hashes for cs.service_api-20230217-py3-none-any.whl
Algorithm Hash digest
SHA256 790d50cc8df4ae6cbde5a657c5b0187c6e637c4c1485c60da3786537806a0e9e
MD5 0144de7c67ed6ee44f2d5430c812451a
BLAKE2b-256 742ada2cbc3353e796bce2d9f129dcea4a4fb4a6cfb78482a66a412ae7bd2803

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page