Skip to main content

z4j -- open-source control plane for Python task infrastructure

Project description

z4j

PyPI version Python License

The all-in-one z4j umbrella package. Open-source control plane for Python task queues.

One pip install z4j brings z4j (dashboard + API) into your environment. Use extras to pull the agent packages your workers need: framework adapters (Django, Flask, FastAPI), engine adapters (Celery, RQ, Dramatiq, Huey, arq, TaskIQ), and their schedule companions. Every adapter cross-versions to the same z4j release line, so the floors stay in sync without manual pinning.

What is z4j

z4j is one product split into 20 PyPI packages so each piece can be installed only where it's needed. The umbrella z4j is the operator-friendly entry point that wires the right combination together for you.

The architecture is straightforward:

  • One brain process per environment. Dashboard, API, audit log. Persistent storage in SQLite or Postgres.
  • One agent per worker / app process. A thin pip package that imports inside your Django / Flask / FastAPI app or your Celery / RQ / Dramatiq worker, opens an authenticated WebSocket to the brain, and streams every task / worker / queue / schedule event.
  • Operator actions flow back the same channel. Retry, cancel, bulk retry, purge, restart, schedule CRUD, manual trigger.

z4j is AGPL v3 and isolated in its own process. The agent packages your application imports are Apache-2.0 each, so your application code is never AGPL-tainted.

What's in the box

Try the live demo (no install)

demo.z4j.dev is the dashboard SPA running in your browser against pre-baked fake data. One click on the pre-filled login lands you in a populated control plane with four sample projects: Celery + celery-beat (small healthy starter), FastAPI + arq + arq-cron, Django + Celery + django-celery-beat with a current incident scenario (failing schedule, alert firing, worker offline), and a mixed-engine z4j-scheduler showcase driving Celery + RQ + Dramatiq workers from one place.

It is a navigable preview, not a sandbox: every Create / Update / Delete button toast-blocks (This is a demo. Refresh to reset; install z4j to make changes for real.), no real backend is connected, refresh resets to a clean state. Useful before you commit to pip install.

Install

The minimum useful install is z4j plus the framework + engine your stack actually uses. Use the extras instead of pinning each package by hand:

pip install z4j                          # brain only
pip install 'z4j[django,celery]'         # Django + Celery + celery-beat
pip install 'z4j[fastapi,arq]'           # FastAPI + arq + arq-cron
pip install 'z4j[flask,rq]'              # Flask + RQ + rq-scheduler
pip install 'z4j[django,celery,scheduler]'   # add z4j-scheduler too

Each extra pulls the matching engine adapter and its schedule companion (e.g. [celery] pulls z4j-celery + z4j-celerybeat). The [scheduler] extra adds z4j-scheduler for operators who want the engine-agnostic dynamic scheduler.

Then start z4j:

z4j serve

First boot mints HMAC secrets, runs Alembic migrations, creates a SQLite database at ~/.z4j/z4j.db, and prints a one-time setup URL to stderr that creates the first admin user. Set Z4J_DATABASE_URL=postgresql+asyncpg://... to use Postgres.

Why use z4j

z4j exists because every Python task queue ships its own viewer-grade tool (Flower for Celery, rq-dashboard for RQ, Dramatiq has none) and they all stop at viewer-grade. None of them give you:

  • One dashboard across mixed engines (Celery + RQ + arq side by side, common operator workflow).
  • An action surface (retry, cancel, bulk retry, purge, restart) that's safe to put in front of operations and compliance teams.
  • A real audit log that an auditor can walk linearly.
  • Live schedule editing across engines without per-daemon restarts.
  • Self-hosted with no telemetry. z4j phones home only when an admin clicks Check for updates in Settings, and that URL is configurable.

z4j is the boring, self-hosted, audit-friendly choice. Built for homelab operators who want one place to look, and for compliance-sensitive teams who need to answer "who did what when" at quarter-end.

Documentation

Full docs at z4j.dev. The install guide at z4j.dev/getting-started/install/ covers all three paths (pip-SQLite, Docker-SQLite, Docker-Postgres).

License

AGPL-3.0-or-later, see LICENSE. Note: only z4j is AGPL. Every agent package your application imports is Apache-2.0, so your application code is never AGPL-tainted. Commercial licenses available; contact licensing@z4j.com.

Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

z4j-1.6.5.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

z4j-1.6.5-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file z4j-1.6.5.tar.gz.

File metadata

  • Download URL: z4j-1.6.5.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for z4j-1.6.5.tar.gz
Algorithm Hash digest
SHA256 08382c64d6494fe83479517075fdfa5b37e24d998bad8a8f247ee3b06e39551f
MD5 42c1cff95e414c22348a41b7dfc72c5b
BLAKE2b-256 f67a9c8fc6ef09f17170f8f28d8f135fea0d2f0a33dde1b916a20e8022d4f1d6

See more details on using hashes here.

File details

Details for the file z4j-1.6.5-py3-none-any.whl.

File metadata

  • Download URL: z4j-1.6.5-py3-none-any.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for z4j-1.6.5-py3-none-any.whl
Algorithm Hash digest
SHA256 24ae9b8f2a5eec79d370ef45283da004902fa352ce8b7c4f1b2fe0d49ee45539
MD5 939647484c185fe67434e8362bda371e
BLAKE2b-256 58db2d5a04afcfe956742400b84a6ff6618ab66ba3a5551ee0cb3d1e1ecdd1cc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page