incident-io 1.0.0__tar.gz

incident_io-1.0.0/.gitignore

@@ -0,0 +1,14 @@
+.ruff_cache/
+.mypy_cache/
+.pytest_cache/
+dist/
+build/
+*.egg-info/
+__pycache__/
+*.py[cod]
+.venv/
+.venv-verify/
+
+# Dev-only lock. This is a library, so we resolve dependencies fresh rather
+# than pinning what consumers get.
+uv.lock

incident_io-1.0.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2026 incident.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

incident_io-1.0.0/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.5
+Name: incident-io
+Version: 1.0.0
+Summary: Python SDK for the incident.io API
+Project-URL: Documentation, https://api-docs.incident.io/
+Project-URL: Source, https://github.com/incident-io/sdk-python
+Project-URL: Changelog, https://github.com/incident-io/sdk-python/releases
+Author-email: "incident.io" <support@incident.io>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: alerting,api,incident,incident.io,on-call,sdk
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: attrs>=22.2.0
+Requires-Dist: httpx<0.29.0,>=0.23.1
+Description-Content-Type: text/markdown
+
+# incident.io Python SDK
+
+[![PyPI](https://img.shields.io/pypi/v/incident-io)](https://pypi.org/project/incident-io/)
+
+The official Python SDK for the [incident.io](https://incident.io)
+[public API](https://api-docs.incident.io/).
+
+It is generated automatically from our published OpenAPI schema, so it always
+tracks the live API — there is a function for every endpoint, and a type for
+every request and response.
+
+## Install
+
+```bash
+pip install incident-io
+```
+
+Requires Python 3.11 or later.
+
+## Quickstart
+
+Create an API key in your incident.io dashboard under **Settings → API keys**,
+then:
+
+```python
+from incident_io import AuthenticatedClient
+from incident_io.api.incidents_v2 import incidents_v2_list
+from incident_io.models import IncidentsListResultV2
+
+client = AuthenticatedClient(
+    base_url="https://api.incident.io",
+    token="my-api-key",
+)
+
+result = incidents_v2_list.sync(client=client, page_size=25)
+if isinstance(result, IncidentsListResultV2):
+    for incident in result.incidents:
+        print(incident.reference, incident.name)
+```
+
+The `isinstance` check isn't ceremony: a failed request comes back as an
+`ErrorResponse` rather than raising, so `result` is one of the two. The SDK
+ships type annotations, so a type checker will tell you if you skip it.
+
+Every endpoint is a module with four functions. `sync` returns the parsed body
+— but note that our error responses are typed too, so a failed request returns
+an `ErrorResponse` rather than raising. `sync_detailed` returns a `Response`
+carrying `status_code`, `headers` and `parsed`, which is the straightforward way
+to tell the two apart:
+
+```python
+response = incidents_v2_list.sync_detailed(client=client)
+if response.status_code != 200:
+    raise RuntimeError(f"unexpected status {response.status_code}: {response.content!r}")
+```
+
+## Async
+
+`asyncio` and `asyncio_detailed` mirror the two functions above, and share the
+same client:
+
+```python
+result = await incidents_v2_list.asyncio(client=client, page_size=25)
+```
+
+## Configuration
+
+`AuthenticatedClient` takes keyword arguments:
+
+```python
+client = AuthenticatedClient(
+    base_url="https://api.incident.io",
+    token="my-api-key",
+    timeout=httpx.Timeout(30.0),                  # defaults to httpx's own
+    headers={"User-Agent": "my-app/1.0.0"},       # identify your integration
+    raise_on_unexpected_status=True,              # raise instead of returning None
+    httpx_args={"proxy": "http://localhost:8080"},
+)
+```
+
+Pass `raise_on_unexpected_status=True` to raise
+`incident_io.errors.UnexpectedStatus` on a status
+the schema doesn't document, instead of returning `None`. Documented errors
+still come back as an `ErrorResponse`; check `status_code` for those.
+
+To reuse a connection pool or bring your own transport, pass
+`httpx_args`, or hand the client a configured instance with
+`client.set_httpx_client(...)`.
+
+### Pagination
+
+List endpoints are cursor-paginated. Read the next cursor from
+`pagination_meta.after` and pass it back as `after`:
+
+```python
+from incident_io.types import UNSET, Unset
+
+after: str | Unset = UNSET
+while True:
+    page = incidents_v2_list.sync(client=client, page_size=100, after=after)
+    if not isinstance(page, IncidentsListResultV2):
+        raise RuntimeError(f"request failed: {page}")
+
+    for incident in page.incidents:
+        print(incident.reference, incident.name)
+
+    # Both the metadata and the cursor within it are optional: the last page
+    # has no cursor to follow.
+    if isinstance(page.pagination_meta, Unset) or isinstance(page.pagination_meta.after, Unset):
+        break
+    after = page.pagination_meta.after
+```
+
+### Deprecated endpoints
+
+Endpoints that incident.io has deprecated (for example the `v1` incidents and
+custom fields endpoints, superseded by `v2`) remain available, but calling one
+issues a `DeprecationWarning` naming the endpoint. Python hides these by
+default, so run with `-W default::DeprecationWarning` to see them.
+
+## Versioning
+
+Releases are cut automatically whenever the API schema changes. We use
+[SemVer](https://semver.org/): additive API changes bump the minor version.
+Changes that would break existing code are never released automatically - they
+require a deliberate major version.
+
+## Support
+
+Found a bug or missing something? Please
+[open an issue](https://github.com/incident-io/sdk-python/issues). For questions
+about the API itself, see the [API docs](https://api-docs.incident.io/).
+
+Note that everything under `incident_io/` is generated - please don't send PRs
+editing it directly; changes there come from the upstream schema.
+
+## License
+
+MIT - see [LICENSE](./LICENSE).
+
+This SDK's generated code is produced by
+[openapi-python-client](https://github.com/openapi-generators/openapi-python-client),
+which is licensed under MIT.

incident_io-1.0.0/README.md

@@ -0,0 +1,143 @@
+# incident.io Python SDK
+
+[![PyPI](https://img.shields.io/pypi/v/incident-io)](https://pypi.org/project/incident-io/)
+
+The official Python SDK for the [incident.io](https://incident.io)
+[public API](https://api-docs.incident.io/).
+
+It is generated automatically from our published OpenAPI schema, so it always
+tracks the live API — there is a function for every endpoint, and a type for
+every request and response.
+
+## Install
+
+```bash
+pip install incident-io
+```
+
+Requires Python 3.11 or later.
+
+## Quickstart
+
+Create an API key in your incident.io dashboard under **Settings → API keys**,
+then:
+
+```python
+from incident_io import AuthenticatedClient
+from incident_io.api.incidents_v2 import incidents_v2_list
+from incident_io.models import IncidentsListResultV2
+
+client = AuthenticatedClient(
+    base_url="https://api.incident.io",
+    token="my-api-key",
+)
+
+result = incidents_v2_list.sync(client=client, page_size=25)
+if isinstance(result, IncidentsListResultV2):
+    for incident in result.incidents:
+        print(incident.reference, incident.name)
+```
+
+The `isinstance` check isn't ceremony: a failed request comes back as an
+`ErrorResponse` rather than raising, so `result` is one of the two. The SDK
+ships type annotations, so a type checker will tell you if you skip it.
+
+Every endpoint is a module with four functions. `sync` returns the parsed body
+— but note that our error responses are typed too, so a failed request returns
+an `ErrorResponse` rather than raising. `sync_detailed` returns a `Response`
+carrying `status_code`, `headers` and `parsed`, which is the straightforward way
+to tell the two apart:
+
+```python
+response = incidents_v2_list.sync_detailed(client=client)
+if response.status_code != 200:
+    raise RuntimeError(f"unexpected status {response.status_code}: {response.content!r}")
+```
+
+## Async
+
+`asyncio` and `asyncio_detailed` mirror the two functions above, and share the
+same client:
+
+```python
+result = await incidents_v2_list.asyncio(client=client, page_size=25)
+```
+
+## Configuration
+
+`AuthenticatedClient` takes keyword arguments:
+
+```python
+client = AuthenticatedClient(
+    base_url="https://api.incident.io",
+    token="my-api-key",
+    timeout=httpx.Timeout(30.0),                  # defaults to httpx's own
+    headers={"User-Agent": "my-app/1.0.0"},       # identify your integration
+    raise_on_unexpected_status=True,              # raise instead of returning None
+    httpx_args={"proxy": "http://localhost:8080"},
+)
+```
+
+Pass `raise_on_unexpected_status=True` to raise
+`incident_io.errors.UnexpectedStatus` on a status
+the schema doesn't document, instead of returning `None`. Documented errors
+still come back as an `ErrorResponse`; check `status_code` for those.
+
+To reuse a connection pool or bring your own transport, pass
+`httpx_args`, or hand the client a configured instance with
+`client.set_httpx_client(...)`.
+
+### Pagination
+
+List endpoints are cursor-paginated. Read the next cursor from
+`pagination_meta.after` and pass it back as `after`:
+
+```python
+from incident_io.types import UNSET, Unset
+
+after: str | Unset = UNSET
+while True:
+    page = incidents_v2_list.sync(client=client, page_size=100, after=after)
+    if not isinstance(page, IncidentsListResultV2):
+        raise RuntimeError(f"request failed: {page}")
+
+    for incident in page.incidents:
+        print(incident.reference, incident.name)
+
+    # Both the metadata and the cursor within it are optional: the last page
+    # has no cursor to follow.
+    if isinstance(page.pagination_meta, Unset) or isinstance(page.pagination_meta.after, Unset):
+        break
+    after = page.pagination_meta.after
+```
+
+### Deprecated endpoints
+
+Endpoints that incident.io has deprecated (for example the `v1` incidents and
+custom fields endpoints, superseded by `v2`) remain available, but calling one
+issues a `DeprecationWarning` naming the endpoint. Python hides these by
+default, so run with `-W default::DeprecationWarning` to see them.
+
+## Versioning
+
+Releases are cut automatically whenever the API schema changes. We use
+[SemVer](https://semver.org/): additive API changes bump the minor version.
+Changes that would break existing code are never released automatically - they
+require a deliberate major version.
+
+## Support
+
+Found a bug or missing something? Please
+[open an issue](https://github.com/incident-io/sdk-python/issues). For questions
+about the API itself, see the [API docs](https://api-docs.incident.io/).
+
+Note that everything under `incident_io/` is generated - please don't send PRs
+editing it directly; changes there come from the upstream schema.
+
+## License
+
+MIT - see [LICENSE](./LICENSE).
+
+This SDK's generated code is produced by
+[openapi-python-client](https://github.com/openapi-generators/openapi-python-client),
+which is licensed under MIT.

incident_io-1.0.0/incident_io/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing incident.io"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

incident_io-1.0.0/incident_io/_query.py

@@ -0,0 +1,31 @@
+"""Query-string helpers added by scripts/fix_generated.py."""
+
+from __future__ import annotations
+
+from typing import Any
+
+
+def flatten_deep_object(name: str, value: Any) -> dict[str, Any]:
+    """Flatten an object-valued query parameter into bracketed keys.
+
+    The API's filters are objects keyed by operator, and some nest a second
+    level keyed by field ID:
+
+        flatten_deep_object("created_at", {"gte": ["2024-05-01"]})
+        -> {"created_at[gte]": ["2024-05-01"]}
+
+        flatten_deep_object("custom_field", {"01ABC": {"one_of": ["x"]}})
+        -> {"custom_field[01ABC][one_of]": ["x"]}
+
+    See scripts/fix_generated.py for why the generated client needs this.
+    """
+    flattened: dict[str, Any] = {}
+
+    for key, inner in value.items():
+        bracketed = f"{name}[{key}]"
+        if isinstance(inner, dict):
+            flattened.update(flatten_deep_object(bracketed, inner))
+        else:
+            flattened[bracketed] = inner
+
+    return flattened

incident_io-1.0.0/incident_io/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

incident_io-1.0.0/incident_io/api/actions_v1/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""