Python client for Incident.io
Project description
python-incident-io-client
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:
-
Every path/method combo becomes a Python module with four functions:
sync
: Blocking request that returns parsed data (if successful) orNone
sync_detailed
: Blocking request that always returns aRequest
, optionally withparsed
set if the request was successful.asyncio
: Likesync
but the async instead of blockingasyncio_detailed
: Likesync_detailed
by async instead of blocking
-
All path/query params, and bodies become method arguments.
-
If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
-
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
Built Distribution
Hashes for python_incidentio_client-0.53.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b04ab580989e30b1b4e49f0cf6c3a33f3e23e70a193a5b8a08339ec707e0423 |
|
MD5 | 7d0ac2429ffbab06e19f6dbe6408f82c |
|
BLAKE2b-256 | 33a0ef61db5b8a1f41bd763fba176f75c1b6e83e0c43b695918ae1fb833c7ba2 |
Hashes for python_incidentio_client-0.53.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a72872653ce9b5cf2cabbfeb37e3da12d980c3825cd9748c61157764376c7673 |
|
MD5 | 31610b1f02226f013e8aa5cc19e7c1d8 |
|
BLAKE2b-256 | faa443be06e50d85c32934c9575965447861a7252fef928f6b4d0bf19c5f9b28 |