apache-airflow-dagsyncer 0.0.1rc1

CLI utility to sync DAG files into an Apache Airflow dags folder

Apache Airflow DagSyncer

Category	Badges
License
PyPI

apache-airflow-dagsyncer is a command-line utility to sync Dag files from a source location into an Apache Airflow dags folder. It copies new and changed .py files while preserving the relative directory layout, making it easy to promote Dags from a source repository into a running Airflow deployment.

Table of contents

• Requirements
• Installing from PyPI
• Getting started
• Usage
• Contributing
• License

Requirements

Component	Version
Python	3.12+
Apache Airflow	3.2.2 or newer

Installing from PyPI

pip install apache-airflow-dagsyncer

Or with uv:

uv pip install apache-airflow-dagsyncer

Getting started

Sync Dags from a source directory into your Airflow dags folder:

apache-airflow-dagsyncer sync --source /path/to/dag-repo --dest $AIRFLOW_HOME/dags

Preview changes without copying anything:

apache-airflow-dagsyncer sync --source /path/to/dag-repo --dest $AIRFLOW_HOME/dags --dry-run

Usage

usage: apache-airflow-dagsyncer [-h] {sync} ...

Sync DAG files from a source location into an Airflow dags folder.

positional arguments:
  {sync}
    sync      Sync DAGs from source to destination

options:
  -h, --help  show this help message and exit

The sync command accepts:

Option	Description
--source	Source directory containing Dag files
--dest	Destination Airflow dags folder
--dry-run	Show what would be synced without copying

It can also be used programmatically:

from airflow.dagsyncer.syncer import sync_dags

sync_dags(source="/path/to/dag-repo", dest="/opt/airflow/dags", dry_run=True)

Contributing

Want to help build this project? Set up a development environment with uv:

git clone https://github.com/abhishekbhakat/apache-airflow-dagsyncer.git
cd apache-airflow-dagsyncer
uv sync
uv run apache-airflow-dagsyncer --help

License

Apache License, Version 2.0