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

Uploaded Python 3

File details

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

File metadata

  • Download URL: z4j_bare-1.6.7.tar.gz
  • Upload date:
  • Size: 111.7 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.7.tar.gz
Algorithm Hash digest
SHA256 38f9b87e394ec9d996784d546d04e6fa69c35a4b9dc0ec1f3978d658bdcaed40
MD5 4514458c7134a94e0fddccd9533a3783
BLAKE2b-256 168fa8950fd1008ed881f764d87be5f48146b4b2df6b5a138a96370a9cad3e60

See more details on using hashes here.

File details

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

File metadata

  • Download URL: z4j_bare-1.6.7-py3-none-any.whl
  • Upload date:
  • Size: 103.8 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 c9aaa2260eaebf467b7480c101c33da62ee14cd4c0887f516c85bd432e6329ce
MD5 4311469c3af33968fa3647b441c31a48
BLAKE2b-256 9ca1c1cbdc2c4c83d2450cfc1d5aaa4c14a39dcdb84d6e0eaec72a4b00a41f6f

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