Installation
pymidil is the official open-source Python SDK for Midil. It's on PyPI and requires
Python 3.12+.
pip install pymidil
Extras
The SDK is modular, so you only install what your service needs on top of the base package:
| Extra | Adds | Use when |
|---|---|---|
pymidil[auth] | An HTTP client | You're sending telemetry to Observatory over HTTP. This is the path used throughout these docs |
pymidil[aws] | AWS SQS support | You want to use the SDK's built-in SQS consumer/producer instead of your own |
pymidil[redis] | A Redis client | You want a Redis-backed idempotency store, or the built-in Redis producer |
pymidil[full] | Everything above | You're not sure yet, or you use more than one of the above |
For most first-time setups:
pip install "pymidil[auth]"
Next steps
Pick the path that matches how you want to instrument your services:
- Quickstart: observe an existing consumer: wrap the consumer you already run, no rewrite.
- Quickstart: build on the event runtime: get retries, dead-lettering, and idempotency handled for you.