cron-pydantic 0.1.0

Pydantic models for cron

cron-pydantic

Pydantic models for cron schedules, jobs, and crontab files.

Installation

pip install cron-pydantic

Usage

Define a crontab from Python or validate the equivalent YAML with CronConfiguration.model_validate:

from cron_pydantic import CronConfiguration

configuration = CronConfiguration.model_validate(
    {
        "environment": {"PATH": "/usr/local/bin:/usr/bin"},
        "job": {
            "backup": {
                "schedule": "0 2 * * *",
                "command": "/opt/bin/backup",
            },
            "cleanup": {
                "schedule": "@weekly",
                "command": "/opt/bin/cleanup",
                "enabled": False,
            },
        },
    }
)

print(configuration.to_cron())

This renders:

# Generated by cron-pydantic
PATH=/usr/local/bin:/usr/bin

# cron-pydantic: backup
0 2 * * * /opt/bin/backup
# cron-pydantic: cleanup
# @weekly /opt/bin/cleanup

Use system=True and provide each job's user to render /etc/crontab or /etc/cron.d format:

configuration = CronConfiguration.model_validate(
    {
        "system": True,
        "job": {
            "backup": {
                "schedule": "@daily",
                "user": "root",
                "command": "/opt/bin/backup",
            }
        },
    }
)

Parse existing content with CronConfiguration.from_cron, load YAML or crontab files with CronConfiguration.load, and write rendered content with configuration.write(path).

cron-pydantic does not install a crontab or modify the host scheduler. This keeps rendering and validation separate from deployment and avoids replacing unmanaged crontab entries.

Supported syntax

• Five-field user crontab schedules
• Six-field system crontab entries containing a user
• Lists, ranges, steps, month and weekday names, and Cronie random ranges
• @reboot, @yearly, @annually, @monthly, @weekly, @daily, @midnight, and @hourly
• Environment assignments and disabled jobs

[!NOTE] This library was generated using copier from the Base Python Project Template repository.