Skip to main content

A client library for accessing Contenda API

Project description

contenda-api-client

A client library for accessing Contenda API

Usage

First, create a client:

from contenda_api_client import AuthenticatedClient

client = AuthenticatedClient(base_url="https://prod.contenda.io", token="SuperSecretToken")

Note: You'll need to exchange a token for your API key first through the identity endpoint.

Now call your endpoint and use your models:

from contenda_api_client.models import MyDataModel
from contenda_api_client.api.my_tag import get_my_data_model
from contenda_api_client.types import Response

my_data: MyDataModel = get_my_data_model.sync(client=client)
# or if you need more info (e.g. status_code)
response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)

Or do the same thing with an async version:

from contenda_api_client.models import MyDataModel
from contenda_api_client.api.my_tag import get_my_data_model
from contenda_api_client.types import Response

my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)

There are more settings on the generated Client class which let you control more runtime behavior, check out the docstring on that class for more info.

Things to know:

  1. Every path/method combo becomes a Python module with four functions:

    1. sync: Blocking request that returns parsed data (if successful) or None
    2. sync_detailed: Blocking request that always returns a Request, optionally with parsed set if the request was successful.
    3. asyncio: Like sync but async instead of blocking
    4. asyncio_detailed: Like sync_detailed but async instead of blocking
  2. All path/query params, and bodies become method arguments.

  3. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)

  4. Any endpoint which did not have a tag will be in contenda_api_client.api.default

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

contenda-api-client-0.1.1.tar.gz (22.0 kB view details)

Uploaded Source

Built Distribution

contenda_api_client-0.1.1-py3-none-any.whl (60.4 kB view details)

Uploaded Python 3

File details

Details for the file contenda-api-client-0.1.1.tar.gz.

File metadata

  • Download URL: contenda-api-client-0.1.1.tar.gz
  • Upload date:
  • Size: 22.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.1 Darwin/21.4.0

File hashes

Hashes for contenda-api-client-0.1.1.tar.gz
Algorithm Hash digest
SHA256 0e61f18d49649ab20fb5df959b9059d4f189bc4751ad54feb0b224de62d240b1
MD5 124c1f22899f2daaa0999bead82300af
BLAKE2b-256 88cee9a8502d6b6c711a39bab53b02f62336d74ae7b46d9c5ef33b653a88cddc

See more details on using hashes here.

File details

Details for the file contenda_api_client-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for contenda_api_client-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e0fa8937e90072072896197ac6946727b26b59655f61e8499795742ba67d72ff
MD5 a2b764b773cd1772b2be7868df8c16b6
BLAKE2b-256 12b474e7b82d90bed1e8a65475c5a37bac8cb37f616cdebff219e06f4a9f77fb

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