Skip to main content

Cron job storage, execution, and result tracking built on the Tigrbl engine.

Project description

Tigrbl Logo

PyPI - Downloads Hits PyPI - Python Version PyPI - License PyPI - tigrbl_api_cron


Tigrbl API Cron ⏰

A lightweight Tigrbl application that stores cron schedules, exposes CRUD APIs, and runs registered jobs while capturing their execution results.

✨ Features

  • 🗄️ Persists cron jobs as first-class CronJob rows with default CRUD verbs.
  • 🪪 Tracks validity windows, timestamps, and last execution metadata for each schedule.
  • 📜 Records every execution in the CronJobResult table for full observability.
  • ⚙️ Provides a simple registry and executor to run due jobs and persist their outputs or failures.
  • 🚀 Ships with a ASGI application constructor for rapid deployment.

📦 Installation

Using uv

uv add tigrbl_api_cron

Using pip

pip install tigrbl_api_cron

🚀 Quick Start

import asyncio
from datetime import datetime, timezone

from tigrbl_api_cron import (
    CronJob,
    build_app,
    execute_due_jobs,
    register_cron_job,
)

# 1. Build and initialize the API (SQLite in-memory by default)
app = build_app()
asyncio.run(app.initialize())

# 2. Register a callable that will be invoked when its cron job is due
@register_cron_job("demo.pkg")
async def demo_job(*, job: CronJob, session, scheduled_for, now):
    return {"ran_at": now.isoformat()}

# 3. Create a cron job entry (via ORM, REST, or RPC)
async def seed_job():
    async with app.engine.asession() as session:
        job = CronJob(pkg_uid="demo.pkg", cron_expression="*/5 * * * *")
        session.add(job)
        await session.commit()

asyncio.run(seed_job())

# 4. Run due jobs and capture their results
asyncio.run(execute_due_jobs(app, now=datetime.now(timezone.utc)))

🧪 Executing Jobs

  • Register handlers with register_cron_job(pkg_uid).
  • Call execute_due_jobs(app, now=...) from a scheduler or worker process.
  • Results are written to the CronJobResult table and surfaced via the REST API.

📄 License

This project is licensed under the terms of the Apache 2.0 license.

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

tigrbl_api_cron-0.1.2.dev7.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

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

tigrbl_api_cron-0.1.2.dev7-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

Details for the file tigrbl_api_cron-0.1.2.dev7.tar.gz.

File metadata

  • Download URL: tigrbl_api_cron-0.1.2.dev7.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.3 {"installer":{"name":"uv","version":"0.10.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for tigrbl_api_cron-0.1.2.dev7.tar.gz
Algorithm Hash digest
SHA256 30687651e82e59220a794583359e374f6656dd9b6601124f7e186cfa0a6efb81
MD5 4fbabae9a7e8c166134820be780f8e21
BLAKE2b-256 3305a559ed3b18f19cbf922e24ea1237033034100d1f8234f009d1774439c18f

See more details on using hashes here.

File details

Details for the file tigrbl_api_cron-0.1.2.dev7-py3-none-any.whl.

File metadata

  • Download URL: tigrbl_api_cron-0.1.2.dev7-py3-none-any.whl
  • Upload date:
  • Size: 13.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.3 {"installer":{"name":"uv","version":"0.10.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for tigrbl_api_cron-0.1.2.dev7-py3-none-any.whl
Algorithm Hash digest
SHA256 da105577ce529f1011f00304e269ce9337b47430301e540ca0892f27a9238644
MD5 1680d0de43ac2d0710e1eaef086e35ad
BLAKE2b-256 91aa598e5c0347b1f406741cfdeab1faea8f1224ae1e7fa48f92d66ff0846164

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