# python-incident-io-client
A client library for accessing incident.io.
## Installation
To install the client:
```shell
pip install python-incidentio-client
```
## Usage
First, create a client:
```python
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:
```python
from incident_io_client import AuthenticatedClient
client = AuthenticatedClient(base_url="https://api.incident.io", token="SuperSecretToken")
```
Now call your endpoint and use your models:
```python
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:
```python
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.
```python
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**.
```python
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`
1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.
1. `asyncio`: Like `sync` but the async instead of blocking
1. `asyncio_detailed`: Like `sync_detailed` by async instead of blocking
1. All path/query params, and bodies become method arguments.
1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
1. 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](https://pypi.org/project/openapi-python-client/)'s [definition endpoint](https://api-docs.incident.io/#operation/Utilities_OpenAPI); a code generator tool will use the OpenAPI document to generates a sync/async client.
To generare an updated copy of the client:
```shell
poetry install
make download
make generate
```
Raw data
{
"_id": null,
"home_page": "https://github.com/expobrain/python-incidentio-client",
"name": "python-incidentio-client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Daniele Esposti",
"author_email": "daniele.esposti@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/63/3c/4a75d90a10341996d731134925f3b63be7c76553e44082419da009673d87/python_incidentio_client-0.45.0.tar.gz",
"platform": null,
"description": "# python-incident-io-client\n\n\n\nA client library for accessing incident.io.\n\n## Installation\n\nTo install the client:\n\n```shell\npip install python-incidentio-client\n```\n\n## Usage\n\nFirst, create a client:\n\n```python\nfrom incident_io_client import Client\n\nclient = Client(base_url=\"https://api.incident.io\")\n```\n\nIf the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:\n\n```python\nfrom incident_io_client import AuthenticatedClient\n\nclient = AuthenticatedClient(base_url=\"https://api.incident.io\", token=\"SuperSecretToken\")\n```\n\nNow call your endpoint and use your models:\n\n```python\nfrom incident_io_client.models import MyDataModel\nfrom incident_io_client.api.my_tag import get_my_data_model\nfrom incident_io_client.types import Response\n\nmy_data: MyDataModel = get_my_data_model.sync(client=client)\n# or if you need more info (e.g. status_code)\nresponse: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)\n```\n\nOr do the same thing with an async version:\n\n```python\nfrom incident_io_client.models import MyDataModel\nfrom incident_io_client.api.my_tag import get_my_data_model\nfrom incident_io_client.types import Response\n\nmy_data: MyDataModel = await get_my_data_model.asyncio(client=client)\nresponse: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)\n```\n\nBy 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.\n\n```python\nclient = AuthenticatedClient(\n base_url=\"https://internal_api.incident.io\",\n token=\"SuperSecretToken\",\n verify_ssl=\"/path/to/certificate_bundle.pem\",\n)\n```\n\nYou can also disable certificate validation altogether, but beware that **this is a security risk**.\n\n```python\nclient = AuthenticatedClient(\n base_url=\"https://internal_api.incident.io\",\n token=\"SuperSecretToken\",\n verify_ssl=False\n)\n```\n\nThings to know:\n\n1. Every path/method combo becomes a Python module with four functions:\n\n 1. `sync`: Blocking request that returns parsed data (if successful) or `None`\n 1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.\n 1. `asyncio`: Like `sync` but the async instead of blocking\n 1. `asyncio_detailed`: Like `sync_detailed` by async instead of blocking\n\n1. All path/query params, and bodies become method arguments.\n1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)\n1. Any endpoint which did not have a tag will be in `incident_io_client.api.default`\n\n## Generate code\n\nThis client is automatically generated from the Swagger 2.x specs downloaded from the [openapi-python-client](https://pypi.org/project/openapi-python-client/)'s [definition endpoint](https://api-docs.incident.io/#operation/Utilities_OpenAPI); a code generator tool will use the OpenAPI document to generates a sync/async client.\n\nTo generare an updated copy of the client:\n\n```shell\npoetry install\nmake download\nmake generate\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python client for Incident.io",
"version": "0.45.0",
"project_urls": {
"Homepage": "https://github.com/expobrain/python-incidentio-client",
"Repository": "https://github.com/expobrain/python-incidentio-client"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8213c5e17cba72fec6d34d959a495408582704c9698e51fba9455777934e544a",
"md5": "69740776fa340ec0897bd87f44dcfc70",
"sha256": "586ef17e0a484e00a4d88682ddf3fbf87f671dda901fc78c4be91cfe23b9b8ae"
},
"downloads": -1,
"filename": "python_incidentio_client-0.45.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "69740776fa340ec0897bd87f44dcfc70",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 673849,
"upload_time": "2024-04-13T21:18:23",
"upload_time_iso_8601": "2024-04-13T21:18:23.142031Z",
"url": "https://files.pythonhosted.org/packages/82/13/c5e17cba72fec6d34d959a495408582704c9698e51fba9455777934e544a/python_incidentio_client-0.45.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "633c4a75d90a10341996d731134925f3b63be7c76553e44082419da009673d87",
"md5": "1c263277d6fc351e7a8970bd00e4b5f3",
"sha256": "44ec57a52c6afe5edfc7aa5e3436eb159afb4f7bbd44ee98d674ca74e6acfc4a"
},
"downloads": -1,
"filename": "python_incidentio_client-0.45.0.tar.gz",
"has_sig": false,
"md5_digest": "1c263277d6fc351e7a8970bd00e4b5f3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 139195,
"upload_time": "2024-04-13T21:18:25",
"upload_time_iso_8601": "2024-04-13T21:18:25.624696Z",
"url": "https://files.pythonhosted.org/packages/63/3c/4a75d90a10341996d731134925f3b63be7c76553e44082419da009673d87/python_incidentio_client-0.45.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-13 21:18:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "expobrain",
"github_project": "python-incidentio-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "python-incidentio-client"
}
JSON
