Requirements
- Python 3.13+
- uv or another PEP 517-compatible package manager
Install core package
uv add forze
pip install forze
Install with integrations
Install only what you need. Extras map directly to integration packages:
| Extra | Installs |
|---|---|
fastapi |
FastAPI integration (forze_fastapi) |
postgres |
Postgres integration (forze_postgres) |
redis |
Redis/Valkey integration (forze_redis) |
s3 |
S3-compatible integration (forze_s3) |
mongo |
MongoDB integration (forze_mongo) |
temporal |
Temporal integration (forze_temporal) |
socketio |
Socket.IO integration (forze_socketio) |
sqs |
SQS integration (forze_sqs) |
rabbitmq |
RabbitMQ integration (forze_rabbitmq) |
forze_mock is bundled with the core package and requires no extra. It provides in-memory adapters for development and testing without external infrastructure.
Common setup:
uv add 'forze[fastapi,postgres,redis,s3,mongo,temporal,socketio]'
pip install 'forze[fastapi,postgres,redis,s3,mongo,temporal,socketio]'
Quick sanity check
from forze.application.execution import ExecutionRuntime
runtime = ExecutionRuntime()
print(type(runtime).__name__) # ExecutionRuntime
Development Installation
To install the project for local development:
git clone https://github.com/morzecrew/forze
cd forze
uv sync --all-groups --all-extras
This installs test, quality, docs, and integration extras.
Then use just to run necessary commands:
# Run unit and integration tests
just test-fast
# Run performance tests
just test-perf
# Run all quality checks
just quality
# Run all quality checks in strict mode (fail on any issue)
just quality -s
# Serve documentation
just pages serve
# Build diagrams
just pages diagrams