Skip to main content

The scheduler that nobody wants but every application needs.

Project description

Asyncz

Asyncz

🚀 The scheduler that simply works. 🚀

Test Suite Package version Supported Python versions


Documentation: https://asyncz.dymmond.com 📚

Source Code: https://github.com/dymmond/asyncz


Asyncz is a production scheduler for async Python applications and ASGI services. It keeps the familiar scheduler / trigger / store / executor model, but it is built around asyncio, explicit task objects, framework lifecycle integration, durable stores, Python standard logging, and operator tooling that works from both the CLI and the browser.

Asyncz descends from the APScheduler model and was rewritten around Pydantic, async Python runtimes, and Asyncz's own operational workflows. It is not a drop-in APScheduler clone; it keeps the scheduling ideas that fit Asyncz and adds production controls such as dashboard actions, history, logs, and CLI inspection.

Use Asyncz when scheduled work needs to be observable, editable, and safe to operate in production. Tasks can be inspected before they are changed, triggered manually when needed, previewed without advancing their triggers, and followed through history and logs after they run.

Documentation: https://asyncz.dymmond.com

What Asyncz gives you

  • Async runtimes: AsyncIOScheduler for regular async applications and NativeAsyncIOScheduler for environments that already own the event loop.
  • Scheduling primitives: date, interval, cron, and, or, and shutdown triggers.
  • Durable stores: memory, file, mongodb, redis, and sqlalchemy.
  • Asyncz Shapes: validator-agnostic scheduler representation with Pydantic defaults and optional dataclass, attrs, msgspec, or trusted Python values.
  • Executor choices: asyncio event loop execution, thread pools, process pools, and direct debug execution.
  • Safe task control for operators: stable task ids, manual Run now, pause, resume, remove, inspect, preview, and update workflows.
  • Scheduler inspection APIs: process identity, lifecycle timing, task counts, stores, executors, instances visible in the current process, and upcoming run previews.
  • Modern dashboard: task filters, task detail pages, row and bulk actions, links to logs for each task, task edit previews, runtime and instance pages, timeline, scheduler events, audit trail, run history, and log inspection for each run.
  • Packaged dashboard assets: no runtime dependency on public Tailwind, Alpine.js, HTMX, Toastify, or favicon CDNs.
  • Python standard logging throughout the project.

Installation

pip install asyncz

Useful extras:

pip install "asyncz[dashboard]"
pip install "asyncz[localtime]"
pip install "asyncz[attrs]"
pip install "asyncz[msgspec]"

Quick start

import logging

from asyncz.schedulers import AsyncIOScheduler

logging.basicConfig(level=logging.INFO)

scheduler = AsyncIOScheduler()


def cleanup() -> None:
    logging.getLogger(__name__).info("cleanup finished")


scheduler.add_task(cleanup, "interval", minutes=5, id="cleanup-task")
scheduler.start()

Operator workflows

Add a durable task with a stable id:

asyncz add myapp.tasks:cleanup \
  --id cleanup-task \
  --name cleanup \
  --interval 5m \
  --store durable=sqlite:///scheduler.db

Inspect it before touching it:

asyncz inspect cleanup-task --count 5 --store durable=sqlite:///scheduler.db
asyncz inspect cleanup-task --json --store durable=sqlite:///scheduler.db

Preview a metadata change before writing it:

asyncz update cleanup-task \
  --name cleanup-v2 \
  --max-instances 2 \
  --dry-run \
  --store durable=sqlite:///scheduler.db

Apply it without a prompt when the diff is expected:

asyncz update cleanup-task \
  --name cleanup-v2 \
  --max-instances 2 \
  --yes \
  --store durable=sqlite:///scheduler.db

Trigger it immediately, then inspect its next scheduled run:

asyncz run cleanup-task --store durable=sqlite:///scheduler.db
asyncz preview cleanup-task --count 5 --store durable=sqlite:///scheduler.db

Check the active scheduler and upcoming schedule:

asyncz status --store durable=sqlite:///scheduler.db
asyncz doctor --strict --store durable=sqlite:///scheduler.db
asyncz timeline --per-task 3 --limit 50 --store durable=sqlite:///scheduler.db

Core concepts

Asyncz is built around four main component types:

Tasks are the public unit of scheduling. A task combines a callable, a trigger, an executor alias, and the metadata needed to persist and reschedule it correctly.

Logging

Asyncz uses Python's logging module. The default logger namespaces are:

  • asyncz.schedulers
  • asyncz.executors.<alias>
  • asyncz.stores.<alias>

If you need custom logger creation, pass your own loggers_class to the scheduler. That class only needs to implement the same dictionary-like contract used by ClassicLogging.

The dashboard also ships with a log capture layer for the asyncz logger namespace. It can filter by task id, run id, level, and message text. Run history entries include the scheduler identity, coalesced run count, and lifecycle log records, so operators can open a specific run and inspect the logs attached to that run.

ASGI integration

Asyncz can wrap an ASGI app directly:

from asyncz.schedulers import AsyncIOScheduler

scheduler = AsyncIOScheduler()
application = scheduler.asgi(application)

Or you can wire startup and shutdown hooks manually:

from asyncz.schedulers import AsyncIOScheduler

scheduler = AsyncIOScheduler()

app = Lilya(
    routes=[...],
    on_startup=[scheduler.start],
    on_shutdown=[scheduler.shutdown],
)

The scheduler also supports synchronous and asynchronous context managers, which makes it easy to use inside lifespan handlers.

Dashboard quick mount

Install the dashboard extra:

pip install "asyncz[dashboard]"

Mount the dashboard into a Lilya application:

from lilya.apps import Lilya

from asyncz.contrib.dashboard.admin import AsynczAdmin
from asyncz.schedulers import AsyncIOScheduler

scheduler = AsyncIOScheduler()
app = Lilya(
    routes=[...],
    on_startup=[scheduler.start],
    on_shutdown=[scheduler.shutdown],
)

admin = AsynczAdmin(url_prefix="/dashboard", scheduler=scheduler)
admin.include_in(app)

The dashboard is an admin surface rendered by the server and enhanced by packaged Alpine.js and HTMX. It can:

  • filter, sort, and search tasks
  • trigger tasks manually without removing one time tasks from the table
  • open logs for a task directly from its row
  • preview and apply supported task metadata edits through scheduler.update_task()
  • pause, resume, remove, and control tasks in bulk
  • inspect scheduler runtime, instances visible in the current process, and upcoming timelines
  • follow runs through history records and correlated logs
  • audit dashboard management actions separately from execution history

Persistent stores and encryption

The default store is in memory. For durable scheduling, configure a file, MongoDB, Redis, or SQLAlchemy store.

Persistent stores support the ASYNCZ_STORE_ENCRYPTION_KEY environment variable. When it is set, task payloads are encrypted before they are written to the backing store.

Production checklist

  • Use stable task ids for scheduled work that operators may inspect, trigger, pause, resume, or update.
  • Use a durable store for tasks that must survive process restarts.
  • Run asyncz doctor --strict in deployment checks when the scheduler is expected to be ready.
  • Use asyncz inspect, asyncz preview, and asyncz timeline before manual interventions.
  • Use asyncz update --dry-run or the dashboard edit preview before changing task metadata.
  • Mount the dashboard behind your application authentication or enable the dashboard login backend.
  • Configure reverse proxy prefixes explicitly when serving the dashboard behind an external path.
  • Keep task logs on Python's logging module so the dashboard log viewer can correlate run records and task output.

CLI and dashboard

Asyncz ships with:

  • a CLI for version, doctor, instances, start, add, update, list, inspect, preview, timeline, status, run, pause, resume, and remove
  • a Lilya dashboard with a scheduler overview, task controls, task detail pages, edit previews, bulk operations, runtime, instances, timeline, scheduler events, audit trail, run history, and log inspection

See the documentation for usage details:

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

asyncz-0.17.1.tar.gz (208.8 kB view details)

Uploaded Source

Built Distribution

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

asyncz-0.17.1-py3-none-any.whl (284.5 kB view details)

Uploaded Python 3

File details

Details for the file asyncz-0.17.1.tar.gz.

File metadata

  • Download URL: asyncz-0.17.1.tar.gz
  • Upload date:
  • Size: 208.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.17.1 {"ci":true,"cpu":"x86_64","distro":{"id":"noble","libc":{"lib":"glibc","version":"2.39"},"name":"Ubuntu","version":"24.04"},"implementation":{"name":"CPython","version":"3.10.20"},"installer":{"name":"hatch","version":"1.17.1"},"openssl_version":"OpenSSL 3.0.13 30 Jan 2024","python":"3.10.20","system":{"name":"Linux","release":"6.17.0-1018-azure"}} HTTPX2/2.7.0

File hashes

Hashes for asyncz-0.17.1.tar.gz
Algorithm Hash digest
SHA256 5ffa2580d3c8dc2ff01d3cfb60e2d6b8cba27d36d93aa6a02684f021034f867a
MD5 79c283bd4fe8854c21fea61330957413
BLAKE2b-256 8cdbe0c5e259419bbebfe7c7d72d144c2c351627de4478ac0a8dad0d088e8935

See more details on using hashes here.

File details

Details for the file asyncz-0.17.1-py3-none-any.whl.

File metadata

  • Download URL: asyncz-0.17.1-py3-none-any.whl
  • Upload date:
  • Size: 284.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.17.1 {"ci":true,"cpu":"x86_64","distro":{"id":"noble","libc":{"lib":"glibc","version":"2.39"},"name":"Ubuntu","version":"24.04"},"implementation":{"name":"CPython","version":"3.10.20"},"installer":{"name":"hatch","version":"1.17.1"},"openssl_version":"OpenSSL 3.0.13 30 Jan 2024","python":"3.10.20","system":{"name":"Linux","release":"6.17.0-1018-azure"}} HTTPX2/2.7.0

File hashes

Hashes for asyncz-0.17.1-py3-none-any.whl
Algorithm Hash digest
SHA256 83bafc13fbd8aed899ae79e5971dd2c222792a4fe2e9dd7e44e4082073cde024
MD5 8602805a03642924a1925976851b9ebb
BLAKE2b-256 9f60afd39afba4a2c276e913588bf2b6dd0cbd9a7127860fba1ffc9813896649

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