Metadata-Version: 2.4
Name: kinro-sdk
Version: 0.1.1
Summary: Write Kinro project files, rules and parsers; emit the Kinro log contract
License-Expression: Apache-2.0
License-File: LICENSE
License-File: NOTICE
Requires-Python: >=3.13
Description-Content-Type: text/markdown

# kinro-sdk

Everything needed to write a Kinro project file, rules and custom parsers, with type hints for the IDE:

- `kinro.sdk`: `Project`, `Rule`, `RuleContext`, `on`, `Query`, `Lookup`, `Violation`, `Field`, `CID`, built-in rules,
  source configs (`LogSource`, `LokiLogs`/`LokiConfig`, `GraylogLogs`/`GraylogConfig`) and the parsers.
- `kinro.parsers`: the `Parser` base and the built-in parsers.
- `kinro.contract`: the log contract model, `ContractFormatter`, `GelfContractFilter`, `start_heartbeat` and
  `schema.json`, for services that emit contract logs.

Standard library only. The engine (sources, state, alerts, CLI, `kinro.testing.RuleHarness`) ships separately as
the `kinro` package.

Licensed under the Apache License 2.0.

```bash
pip install kinro-sdk                                   # from PyPI
pip install kinro_sdk-0.1.1-py3-none-any.whl
pip install 'kinro-sdk @ git+https://<host>/<org>/kinro.git#subdirectory=packages/kinro-sdk'
pip install --index-url https://<private-index>/simple kinro-sdk
```
