Skip to main content

z4j framework-free agent bootstrapper (Apache 2.0)

Project description

z4j-bare

PyPI version Python License

License: Apache 2.0 Status: v1.0.0 - first public release.

Framework-free agent runtime for z4j. Ships both as a pure-Python supervisor for standalone workers (no Django / Flask / FastAPI) and as proof that z4j-core is genuinely framework-free - z4j-bare is what every framework adapter is built on top of.

Install

pip install z4j-bare

# Optionally add dev-mode filesystem watcher (for live task-registry
# reloads when tasks.py changes on disk; off in production):
pip install "z4j-bare[watcher]"

What it does

  • AgentRuntime - pure-Python agent runtime, no framework hooks.
  • WebSocket transport with exponential-backoff reconnect.
  • HTTPS long-poll fallback for networks that block WebSocket.
  • Local SQLite buffer (WAL mode, size-capped, crash-safe event storage).
  • Command dispatcher - routes brain commands to registered engine + scheduler adapters.
  • Heartbeat loop with liveness + last-seen stamping.
  • Orchestrator detection - identifies Docker / Kubernetes / systemd / supervisord hosts for restart_worker safety-gating.
  • Per-project HMAC v2 signing using the shared wire-protocol helpers from z4j-core.
  • Process singleton guard - prevents duplicate agents from the same project on one host.
  • CLI: python -m z4j_bare run --config ...

Use cases

  • Celery / RQ / Dramatiq workers not served by a web framework.
  • ML pipelines that run Celery but don't use Django.
  • Containers where the agent runs as its own process, separate from the app.
  • Custom Python scripts that dispatch tasks and want to report lifecycle events to the z4j brain.

Usage - in-process

from celery import Celery
from z4j_bare import install_agent
from z4j_celery import CeleryEngineAdapter

app = Celery("myproject", broker="redis://localhost/0")

agent = install_agent(
    engines=[CeleryEngineAdapter(celery_app=app)],
    brain_url="https://z4j.internal",
    token="z4j_agent_...",
    project_id="ml-pipeline-prod",
)

Usage - standalone process

python -m z4j_bare run \
    --brain-url https://z4j.internal \
    --token $Z4J_TOKEN \
    --project-id ml-pipeline-prod \
    --engine celery \
    --celery-app myproject.celery:app

Reliability contract

Per the z4j safety rule (docs/CLAUDE.md §2.2), the agent must never break the host application:

  • No exception inside the runtime propagates to Celery / Django / FastAPI signal handlers.
  • Network I/O never blocks signal handlers (events queue to an in-memory ring, flushed from a background thread).
  • When the brain is unreachable, events buffer to local SQLite with exponential backoff.
  • Buffer drops oldest events when full; the host app is never slowed or blocked.

Documentation

  • Adapter guide - how z4j-bare composes with engine + framework adapters.
  • Architecture - agent/brain topology, transport layer, reconciliation.
  • Security - threat model, HMAC v2 envelope signing, redaction.

License

Apache 2.0. See LICENSE. z4j-bare installs cleanly into proprietary Python workers - there is no copyleft obligation. The brain server it talks to (z4j-brain) is AGPL-3.0; communicating with it over the network does not subject your worker code to AGPL.

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_bare-1.0.1.tar.gz (71.4 kB view details)

Uploaded Source

Built Distribution

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

z4j_bare-1.0.1-py3-none-any.whl (65.0 kB view details)

Uploaded Python 3

File details

Details for the file z4j_bare-1.0.1.tar.gz.

File metadata

  • Download URL: z4j_bare-1.0.1.tar.gz
  • Upload date:
  • Size: 71.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.8

File hashes

Hashes for z4j_bare-1.0.1.tar.gz
Algorithm Hash digest
SHA256 8f876f4dcc89bfc664cc32c05b6ff9bfabbabac3ecfcf386160b412139332b85
MD5 9ddcde680072c1cb09f3e1b62e715f67
BLAKE2b-256 beaed8fc3550b8fb58ed88a5750631c306ed0b5ca732d95b1889990190a81862

See more details on using hashes here.

File details

Details for the file z4j_bare-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: z4j_bare-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 65.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.8

File hashes

Hashes for z4j_bare-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f8254ef424940c8d68c6ee6783d05f0574b51448a6d2d0c458e35376dc0b60fd
MD5 07274cf997ec64d475494b993d7ddfac
BLAKE2b-256 dc8779f5bdf193c2acc1cba354463f2fc57bb0055e0b762711829b1c19f23a03

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