In memory of my father, who passed away in 2023 from COVID-19.
PyPepper is a small toolkit—not a full framework—for wiring services: HTTP / SSE, FSM, a workflow scheduler, signed events, thin DB helpers, and optional OpenTelemetry tracing. Supports Python 3.10–3.14.
- Repo: github.com/jovijovi/pypepper
- Docs: jovijovi.github.io/pypepper
- Changelog:
CHANGELOG.md
pip install pypepper
Documentation
Getting Started · Tutorial · Architecture · Guides · API Reference
Source under docs/. Local preview: make docs-serve.
Domains
| Package | Role | |
|---|---|---|
| Common | pypepper.common |
Config, logging, context, cache, crypto, utilities |
| Event | pypepper.event |
Signed domain events with JSON marshal |
| FSM | pypepper.fsm |
Event-triggered state machine with rollback |
| Scheduler | pypepper.scheduler |
Job → Channel → Worker → Workflow + pluggable job stores |
| Network | pypepper.network |
FastAPI HTTP server and SSE subsystem |
| Helper | pypepper.helper |
MySQL / PostgreSQL / MongoDB connectors |
Highlights
| Network | FastAPI HTTP + SSE; header API-key auth and rate limits (auth-off needs PYPEPPER_SSE_ALLOW_AUTH_OFF) → guide |
| FSM & events | Rollback on handler failure; signed JSON payloads → guide |
| Scheduler | Rounds, soft timeouts, and retries; durable job-store fail-fast → guide |
| Tracing | Opt-in OpenTelemetry (console / local Jaeger) → guide |
| Quality | PEP 561 py.typed · ruff + mypy CI · line + branch coverage ≥ 90% |
| Data | Thin DB helpers → guide |
Quick start
Requires Python 3.10–3.14. uv ≥ 0.10.7 is recommended for local installs.
make build-prepare
SSE example (set a key; default config enables authentication):
export PYPEPPER_SSE_API_KEY=your-local-key
python example/sse/app.py
HTTP example:
python example/server/app.py --config ./conf/app.config.yaml
Scheduler end-to-end example: python example/scheduler/app.py.
Full walkthrough: Getting Started · First service tutorial.
Developer commands
make lint # ruff + mypy
make check # lint + mutable class-attr guard
make test # check + pytest (coverage ≥ 90%, branch on)
make docs # mkdocs build --strict
make audit # pip-audit on production requirements
make docker # local image
make clean
Contributing
See CONTRIBUTING.md for setup, Conventional Commits, and PR expectations.
Release tags: docs/guides/release.md.
Security
See SECURITY.md for supported versions and private reporting.
Leaving SSE authentication off without PYPEPPER_SSE_ALLOW_AUTH_OFF is rejected by the library (HTTP 503).
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pypepper-0.6.4.tar.gz.
File metadata
- Download URL: pypepper-0.6.4.tar.gz
- Upload date:
- Size: 277.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
16e61027f83d4e79c315422b9724bac893717dcaee67e34c2061d42fce854bc0
|
|
| MD5 |
2af3380f3daf766e07c66cdfcb1e7b4d
|
|
| BLAKE2b-256 |
9be345a18d6777f2f8dee46cbe5806badf0766f03e526b8c185ca40b64088e9a
|
Provenance
The following attestation bundles were made for pypepper-0.6.4.tar.gz:
Publisher:
publish.yml on jovijovi/pypepper
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pypepper-0.6.4.tar.gz -
Subject digest:
16e61027f83d4e79c315422b9724bac893717dcaee67e34c2061d42fce854bc0 - Sigstore transparency entry: 2222175172
- Sigstore integration time:
-
Permalink:
jovijovi/pypepper@c476d36162bc45eb3408a284fafb1038cffd469a -
Branch / Tag:
refs/tags/v0.6.4 - Owner: https://github.com/jovijovi
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@c476d36162bc45eb3408a284fafb1038cffd469a -
Trigger Event:
push
-
Statement type:
File details
Details for the file pypepper-0.6.4-py3-none-any.whl.
File metadata
- Download URL: pypepper-0.6.4-py3-none-any.whl
- Upload date:
- Size: 68.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c0664a4b7ab4134163c7904e1c644b1c1cd2e6d767929c7f3f39182616fa01f4
|
|
| MD5 |
aec398f017745d1acaef40b08c9b328c
|
|
| BLAKE2b-256 |
f2e13e6a0dae227e5fe4ca4aa1bb6a3166c8e8f171f38b9076ecb776c6290dcb
|
Provenance
The following attestation bundles were made for pypepper-0.6.4-py3-none-any.whl:
Publisher:
publish.yml on jovijovi/pypepper
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pypepper-0.6.4-py3-none-any.whl -
Subject digest:
c0664a4b7ab4134163c7904e1c644b1c1cd2e6d767929c7f3f39182616fa01f4 - Sigstore transparency entry: 2222175651
- Sigstore integration time:
-
Permalink:
jovijovi/pypepper@c476d36162bc45eb3408a284fafb1038cffd469a -
Branch / Tag:
refs/tags/v0.6.4 - Owner: https://github.com/jovijovi
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@c476d36162bc45eb3408a284fafb1038cffd469a -
Trigger Event:
push
-
Statement type: