Metadata-Version: 2.4
Name: boomerang-contracts
Version: 0.1.0
Summary: Shared Boomerang alert and notification contracts.
License: Apache-2.0
Author: Julien Weber
Author-email: jpkwbr@protonmail.com
Requires-Python: >=3.11,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: pydantic (>=2.0.0,<3.0.0)
Project-URL: Homepage, https://github.com/kontiki-org/boomerang
Project-URL: Repository, https://github.com/kontiki-org/boomerang
Description-Content-Type: text/markdown

# boomerang-contracts

Shared Pydantic models for [Boomerang](https://github.com/kontiki-org/boomerang)
alert producers and notifiers.

Install:

```bash
pip install boomerang-contracts
```

## What you get

| Area | Import | Role |
|------|--------|------|
| Ingest | `NormalizedAlert`, `ALERT_NORMALIZED_EVENT` | Producer → alert-engine |
| Catalogues | `AlertConnectorCatalog`, `NotificationChannelCatalog`, … | RPC catalogue payloads |
| Delivery | `NotificationRequest`, outcomes | alert-engine → notifier |

```python
from boomerang_contracts import (
    ALERT_NORMALIZED_EVENT,
    NormalizedAlert,
    NotificationRequest,
)
```

Full field reference: [`docs/contracts.md`](https://github.com/kontiki-org/boomerang/blob/main/docs/contracts.md)
in the Boomerang repository.

## License

Apache-2.0

