Cloud native framework for building event driven applications in Python
Note: This package is under active development and is not recommended for production use
Version: 0.1.24
Documentation: https://performancemedia.github.io/eventiq/
Repository: https://github.com/performancemedia/eventiq
About
The package utilizes anyio and pydantic as the only required dependencies.
For messages Cloud Events format is used.
Service can be run as standalone processes, or included into starlette (e.g. FastAPI) applications.
Installation
pip install eventiq
Multiple broker support (in progress)
- Stub (in memory using
asyncio.Queuefor PoC, local development and testing) - NATS (with JetStream)
- Redis Pub/Sub
- Kafka
- Rabbitmq
- Google Cloud PubSub
- And more coming
Optional Dependencies
cli-typer- broker of choice:
nats,kafka,rabbitmq,redis,pubsub - custom message serializers:
msgpack,orjson prometheus- Metric exposure viaPrometheusMiddlewareopentelemetry- tracing support
Motivation
Python has many "worker-queue" libraries and frameworks, such as:
However, those libraries don't provide a pub/sub pattern, useful for creating
event driven and loosely coupled systems. Furthermore, the majority of those libraries
do not support asyncio. This is why this project was born.
Basic usage
import asyncio
from eventiq import Service, CloudEvent, Middleware
from eventiq.backends.nats.broker import JetStreamBroker
class SendMessageMiddleware(Middleware):
async def after_broker_connect(self, broker: "Broker") -> None:
print(f"After service start, running with {broker}")
await asyncio.sleep(10)
for i in range(100):
await broker.publish("test.topic", data={"counter": i})
print("Published event(s)")
broker = JetStreamBroker(url="nats://localhost:4222")
broker.add_middleware(SendMessageMiddleware())
service = Service(name="example-service", broker=broker)
@service.subscribe("test.topic")
async def example_run(message: CloudEvent):
print(f"Received Message {message.id} with data: {message.data}")
if __name__ == "__main__":
service.run()
Scaling
Each message is load-balanced (depending on broker) between all service instances with the same name.
To scale number of processes you can use containers (docker/k8s), supervisor,
or web server like gunicorn.
Features
- Modern,
asynciobased python 3.8+ syntax - Minimal dependencies, only
pydanticandpython-json-loggerare required - Automatic message parsing based on type annotations (like FastAPI)
- Code hot-reload
- Highly scalable: each service can process hundreds of tasks concurrently, all messages are load balanced between all instances by default
- Resilient - at least once delivery for all messages by default
- Customizable & pluggable message encoders (json, msgpack, custom)
- Json formatted logger
- Multiple broker support (Nats, Kafka, Rabbitmq, Redis, PubSub, and more coming)
- Easily extensible via Middlewares and Plugins
- Cloud Events standard as base message structure (no more python specific
*argsand**kwargsin messages) - AsyncAPI documentation generation from code
- Twelve factor app approach - stdout logging, configuration through environment variables
- Out-of-the-box integration with Prometheus (metrics) and OpenTelemetry (tracing)
- Application bootstrap via
.yamlfile (see examples/configuration)
Metadata
Release files for eventiq 0.1.24
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| eventiq-0.1.24.tar.gz | 36.0 kB | Without provenance | Details for eventiq-0.1.24.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| eventiq-0.1.24-py3-none-any.whl | Python 3 | none | any | Details for eventiq-0.1.24-py3-none-any.whl |
Total release size: 89.3 kB
Release files / eventiq-0.1.24.tar.gz
| Download URL | eventiq-0.1.24.tar.gz |
|---|---|
| Size | 36.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dce0eb41555df59fa291cbea4078512321839cd43d75137ed9d33dacd496d79d
|
|
BLAKE2b-256 checksum How to use checksums |
81dc69c2ce9919cffacdec1474e1b8fe6a3f1a0472acc6a552d1fd1254734205
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
Release files / eventiq-0.1.24-py3-none-any.whl
| Download URL | eventiq-0.1.24-py3-none-any.whl |
|---|---|
| Size | 53.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c7f74348da9f06a5bc3820f28ce9ff442ac9b33813937cad5d90ec5fe5ec5c5d
|
|
BLAKE2b-256 checksum How to use checksums |
8327d00330cec0a2153d4eb13491281e0609da92ff7a8b59dc5a9464574d4051
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
Security for eventiq 0.1.24
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.