Metadata-Version: 2.5
Name: airflow-cron
Version: 0.1.1
Summary: Airflow DAG generation from cron syntax
Project-URL: Repository, https://github.com/airflow-laminar/airflow-cron
Project-URL: Homepage, https://github.com/airflow-laminar/airflow-cron
Author-email: the airflow-cron authors <t.paine154@gmail.com>
License: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.11
Requires-Dist: airflow-pydantic<1.8,>=1.7.0
Requires-Dist: cron-pydantic<0.2,>=0.1
Provides-Extra: airflow
Requires-Dist: apache-airflow-providers-ssh; extra == 'airflow'
Requires-Dist: apache-airflow-providers-standard; extra == 'airflow'
Requires-Dist: apache-airflow<3,>=2.8; extra == 'airflow'
Provides-Extra: airflow3
Requires-Dist: apache-airflow-providers-ssh; extra == 'airflow3'
Requires-Dist: apache-airflow-providers-standard; extra == 'airflow3'
Requires-Dist: apache-airflow<3.4,>=3; extra == 'airflow3'
Provides-Extra: develop
Requires-Dist: airflow-pydantic<1.8,>=1.7.0; extra == 'develop'
Requires-Dist: build; extra == 'develop'
Requires-Dist: bump-my-version; extra == 'develop'
Requires-Dist: check-dist; extra == 'develop'
Requires-Dist: codespell; extra == 'develop'
Requires-Dist: cron-pydantic<0.2,>=0.1; extra == 'develop'
Requires-Dist: hatchling; extra == 'develop'
Requires-Dist: mdformat; extra == 'develop'
Requires-Dist: mdformat-tables>=1; extra == 'develop'
Requires-Dist: pytest; extra == 'develop'
Requires-Dist: pytest-cov; extra == 'develop'
Requires-Dist: ruff; extra == 'develop'
Requires-Dist: twine; extra == 'develop'
Requires-Dist: ty; extra == 'develop'
Requires-Dist: uv; extra == 'develop'
Requires-Dist: wheel; extra == 'develop'
Description-Content-Type: text/markdown

# airflow-cron

Generate declarative Airflow DAG models from cron configuration.

[![Build Status](https://github.com/airflow-laminar/airflow-cron/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/airflow-laminar/airflow-cron/actions/workflows/build.yaml)
[![codecov](https://codecov.io/gh/airflow-laminar/airflow-cron/branch/main/graph/badge.svg)](https://codecov.io/gh/airflow-laminar/airflow-cron)
[![License](https://img.shields.io/github/license/airflow-laminar/airflow-cron)](https://github.com/airflow-laminar/airflow-cron)
[![PyPI](https://img.shields.io/pypi/v/airflow-cron.svg)](https://pypi.python.org/pypi/airflow-cron)

```python
from airflow_cron import CronAirflowConfiguration, create_dags

config = CronAirflowConfiguration.model_validate(
    {
        "job": {
            "backup": {
                "schedule": "0 2 * * *",
                "command": "/opt/jobs/backup",
            }
        }
    }
)

dag_models = create_dags(config)
```

Each enabled user-crontab job becomes one `airflow-pydantic` DAG containing one
Bash task. The result can be instantiated directly or added to an
`airflow-config` configuration.

## Documentation

- [Tutorial: generate an Airflow DAG](docs/src/tutorial.md)
- [How-to guides](docs/src/how-to.md)
- [Why cron jobs become DAG models](docs/src/explanation.md)
- [API reference](docs/src/api.md)

Published documentation is available at
[airflow-laminar.github.io/airflow-cron](https://airflow-laminar.github.io/airflow-cron/).

## Ecosystem

- [cron-pydantic](https://github.com/airflow-laminar/cron-pydantic) provides the source crontab models.
- [supervisor-pydantic](https://github.com/airflow-laminar/supervisor-pydantic) and [systemd-pydantic](https://github.com/airflow-laminar/systemd-pydantic) model process managers.
- [airflow-supervisor](https://github.com/airflow-laminar/airflow-supervisor) and [airflow-systemd](https://github.com/airflow-laminar/airflow-systemd) manage long-running jobs.
- [airflow-pydantic](https://github.com/airflow-laminar/airflow-pydantic) supplies generated DAG and task models.
- [airflow-config](https://github.com/airflow-laminar/airflow-config) applies shared YAML configuration and materializes DAGs.

> [!NOTE]
> This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base).
