Skip to main content

z4j Celery-beat scheduler adapter (Apache 2.0)

Project description

z4j-celerybeat

PyPI version Python License

The Celery Beat scheduler adapter for z4j.

Surfaces periodic / crontab / one-shot Celery schedules on the dashboard's Schedules page, read, create, update, enable, disable, trigger, delete. Supports both Celery's static app.conf.beat_schedule and the database-backed django_celery_beat.models.PeriodicTask.

What it ships

Capability Notes
List schedules from both static config and django-celery-beat
Read individual schedule by id
Create schedule django-celery-beat backend (static is read-only)
Update interval / crontab / args / kwargs / enabled flag
Enable / disable via is_enabled toggle
Trigger now fires the underlying task immediately, outside the schedule
Delete django-celery-beat backend
Live sync django-celery-beat changes flow to the dashboard automatically
Boot inventory full snapshot at agent connect; existing schedules show up without editing

Static beat_schedule is read-only by design, you can view, enable, disable, and trigger, but create / update / delete need a deploy round-trip. The dashboard hides buttons it can't honor.

Install

pip install z4j-celery z4j-celerybeat

With django-celery-beat (most Django projects)

# settings.py
INSTALLED_APPS = [
    # ...
    "django_celery_beat",
    "z4j_django",
]

The Schedules page picks up every PeriodicTask row immediately. Edits flow both ways, dashboard changes write through to the database, and changes written directly to the model surface via Django signals.

With static beat_schedule (plain Celery)

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

app = Celery("myproject", broker="redis://localhost")
app.conf.beat_schedule = {
    "cleanup-every-5-minutes": {
        "task": "myapp.tasks.cleanup",
        "schedule": 300.0,
    },
}

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

Pairs with

Reliability

  • No exception from the adapter ever propagates back to Celery Beat, Django request handlers, or PeriodicTask signal receivers.
  • Database writes for PeriodicTask happen in the dashboard's request context with normal Django ORM semantics, even if z4j is unreachable, the local model write is never affected.

Documentation

Full docs at z4j.dev/schedulers/celery-beat/.

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_celerybeat-1.6.0.tar.gz (24.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_celerybeat-1.6.0-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file z4j_celerybeat-1.6.0.tar.gz.

File metadata

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

File hashes

Hashes for z4j_celerybeat-1.6.0.tar.gz
Algorithm Hash digest
SHA256 57913a611d5d9d6bf13237f050343317e8e2ff073bf5750d38e716924c8c885a
MD5 49ca9e9bd0b60fb5a49be403a4ddd2d7
BLAKE2b-256 b04866812cb5d3de537e746d72e9a6f29af1228c23f68ce491001adc46adea78

See more details on using hashes here.

File details

Details for the file z4j_celerybeat-1.6.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for z4j_celerybeat-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e2a23a7badd427388543ed2281f8fbd941fa1172f3fa072a3de70c5ecae1f458
MD5 ce6bd82dbb07f1aab63d99c8572da8ce
BLAKE2b-256 59ee57c7ab58c11bfad3c585787c495543a0f6e961e909b273f263a67d41a0b4

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