Skip to main content

z4j framework-free agent bootstrapper (Apache 2.0)

Project description

z4j-bare

PyPI version Python License

The framework-free agent runtime for z4j.

Bootstraps a z4j agent inside any Python process, Celery worker, RQ worker, Dramatiq actor, plain script, custom service, and connects it to z4j over an authenticated WebSocket. Used directly when there's no framework adapter (z4j-django / z4j-flask / z4j-fastapi); used indirectly by those framework adapters too.

Compatibility

Python 3.11+. No framework or engine pinned; pair with whichever engine adapter your worker runs (z4j-celery, z4j-rq, z4j-dramatiq, z4j-huey, z4j-arq, z4j-taskiq) and that adapter carries the engine-version floor.

Full per-adapter matrix at https://z4j.dev/reference/compatibility/.

What it ships

  • Agent runtime, connect, authenticate, supervise, reconnect with bounded backoff
  • Outbound buffer, every event written to a local SQLite ring before going out on the wire; durable across short brain outages and agent restarts
  • Engine signal hooks, wired up by whichever engine adapter you install (z4j-celery, z4j-rq, etc.); the runtime drains them into the buffer
  • Schedule inventory, emits a full snapshot at boot, on a periodic timer (default 15 min), and on demand from the brain's Sync now command. Existing schedules show up automatically.
  • Command dispatcher, receives operator actions from the brain (retry, cancel, restart, schedule.fire, schedule.resync, etc.) and routes them to the right adapter

Install

pip install z4j-bare

Most users install a framework adapter (z4j-django / z4j-flask / z4j-fastapi) which pulls z4j-bare automatically.

Quick start (framework-free worker)

from z4j_bare import install_agent
from z4j_celery import CeleryEngineAdapter

install_agent(
    engines=[CeleryEngineAdapter(celery_app=app)],
    brain_url="https://brain.example.com",
    token="z4j_agent_...",
    project_id="my-project",
)

Reliability

  • No exception from the agent ever propagates back into your worker / signal handler / request path. Every brain interaction is wrapped in a top-level try/except.
  • Events buffer locally when z4j is unreachable. Workers never block on network I/O.
  • Supervisor reconnects on every transient failure (network, TLS, protocol mismatch) with bounded backoff.

Documentation

Full docs at z4j.dev/frameworks/bare/.

License

Apache-2.0, see LICENSE.

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.6.9.tar.gz (124.0 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.6.9-py3-none-any.whl (109.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for z4j_bare-1.6.9.tar.gz
Algorithm Hash digest
SHA256 b1469ff4bd2ab81ed994451fc8c87c3fc1f2f7f66747f9582e5938aa8ec43a9c
MD5 80e1452e830487453df8bd7d8dd1a03c
BLAKE2b-256 28882d3abe38565b5050cbef4a68c67378b7de5bc5623060b864f494b40e376d

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for z4j_bare-1.6.9-py3-none-any.whl
Algorithm Hash digest
SHA256 ea72135021b8fc0804a0d93d629b0da05413f9623ae8a062019259143abbb7f2
MD5 c7c0f9c34e174657f945d9ca3bf6cfba
BLAKE2b-256 049faadc56f9e818f9ef2a6091c0d8b3c80230f184e645a952698bd705ca05c8

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