Project Status
Release state
Philter Diffuse is early-access software at version 0.1.0.
The differential-privacy mechanism (Discrete Laplace via OpenDP), the privacy-budget accounting, and the command-line interface are usable and covered by tests. Because it is a 0.x release, the command-line interface and output format may still change before a stable 1.0. Pin to a specific commit or release if you depend on the current behavior.
Check the version of your checkout at any time:
python main.py --version
This is the authoritative status for the product. Marketing or product-page copy should defer to the version and checklist here rather than implying a stable release exists before one is tagged.
Maturity checklist
The current state of the things a developer-facing tool needs before it is "done":
| Area | State | Notes |
|---|---|---|
| Tests | Done | test_main.py exercises privatization, budget tracking, thresholding, JSON/Mongo ingestion, the aggregates reader, and reading counts from Philter's API against a stubbed Philter; CI runs pytest on every push and pull request (.github/workflows/tests.yml). |
| Examples | Done | example.sh (local JSON run) and run-docker.sh (containerized run) are runnable end to end; the Quickstart is a worked walkthrough. |
| Docs | Done | Install, usage, CLI options, privacy-budget management, quickstart, and FAQ are published to https://philterd.github.io/philter-diffuse/ and rebuilt on every push (.github/workflows/docs.yml). |
| Release artifact | Done | 0.1.0 is tagged, with a GitHub release and a Docker image, philterd/philter-diffuse, for linux/amd64 and linux/arm64. Philter Diffuse is not packaged for PyPI. |
When the checklist items change, update this table and the __version__ in main.py together.
Roadmap to 1.0
- Freeze the CLI flags and CSV schema, then promote to
1.0.0.