Skip to main content

Python client for Incident.io

Project description

python-incident-io-client

main build status

A client library for accessing incident.io.

Installation

To install the client:

pip install python-incidentio-client

Usage

First, create a client:

from incident_io_client import Client

client = Client(base_url="https://api.incident.io")

If the endpoints you're going to hit require authentication, use AuthenticatedClient instead:

from incident_io_client import AuthenticatedClient

client = AuthenticatedClient(base_url="https://api.incident.io", token="SuperSecretToken")

Now call your endpoint and use your models:

from incident_io_client.models import MyDataModel
from incident_io_client.api.my_tag import get_my_data_model
from incident_io_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 incident_io_client.models import MyDataModel
from incident_io_client.api.my_tag import get_my_data_model
from incident_io_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)

By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.

client = AuthenticatedClient(
    base_url="https://internal_api.incident.io",
    token="SuperSecretToken",
    verify_ssl="/path/to/certificate_bundle.pem",
)

You can also disable certificate validation altogether, but beware that this is a security risk.

client = AuthenticatedClient(
    base_url="https://internal_api.incident.io",
    token="SuperSecretToken",
    verify_ssl=False
)

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 the async instead of blocking
    4. asyncio_detailed: Like sync_detailed by 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 incident_io_client.api.default

Generate code

This client is automatically generated from the Swagger 2.x specs downloaded from the openapi-python-client's definition endpoint; a code generator tool will use the OpenAPI document to generates a sync/async client.

To generare an updated copy of the client:

poetry install
make download
make generate

Project details


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

python_incidentio_client-0.53.7.tar.gz (205.3 kB view details)

Uploaded Source

Built Distribution

python_incidentio_client-0.53.7-py3-none-any.whl (893.2 kB view details)

Uploaded Python 3

File details

Details for the file python_incidentio_client-0.53.7.tar.gz.

File metadata

File hashes

Hashes for python_incidentio_client-0.53.7.tar.gz
Algorithm Hash digest
SHA256 b81673293d8e97a72cae8fa8d46d39af1c7773e751689c95eb64ba32185ae409
MD5 f274048e3158213b94574adc91abb59b
BLAKE2b-256 52be36a8b27148ce8cbfe3c6363adfa8ac51335759129b321a5b3139874f1247

See more details on using hashes here.

File details

Details for the file python_incidentio_client-0.53.7-py3-none-any.whl.

File metadata

File hashes

Hashes for python_incidentio_client-0.53.7-py3-none-any.whl
Algorithm Hash digest
SHA256 11dc8269a1e0bab85e5b50ef1cec2614fc8de0351e37d0fd37c8823bb19cd0ca
MD5 294e7661b42d7e63e3809854300ca539
BLAKE2b-256 52c3a653019b83171ea2b5db514c3ecc40a10f87111e23a0f38f43fe26e3a482

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