airflow-cli 0.1.18

CLI to handle Airflow in Docker Environment

Airflow Docker Helper

A command-line tool to facilitate the setup of Apache Airflow using Docker and enable local DAG development and testing.

Features

• 🚀 Quick Airflow setup with Docker Compose
• 🔧 Local DAG development and testing
• 📦 Pre-configured Docker environment
• 🛠️ CLI interface for common Airflow operations
• 🧪 Testing utilities for DAG validation

Prerequisites

• Python 3.7+
• Docker and Docker Compose
• Git

Installation

From PyPI (Recommended)

pip install airflow-cli

Quick Start

1. Start Airflow Environment

actl up

This command will:

• Check Docker installation and environment
• Create last docker-compose.yml
• Start Airflow services with Docker Compose

2. Access Airflow UI

Open your browser and navigate to http://localhost:8080

Default credentials:

• Username: airflow
• Password: airflow

3. Stop Airflow Environment

actl down

Usage

Available Commands

# Start Docker environment
actl up

# Stop Docker environment
actl down

# Run Airflow DAG inside Docker
actl run

# Run flake8 linter on DAGs
actl fix

# Show help
actl --help

DAG Development

1. Place your DAG files in the dags/ directory
2. The directory is automatically mounted to the Airflow container
3. Changes are reflected immediately (no restart required)

Expected DAG structure for run-dag command:

project/
├── dags/
│   └── my_dag/
│       ├── config.yml
│       └── dag.py

Example config.yml:

args:
  id: "my_dag_id"

Testing DAGs

Run a DAG inside Docker

actl run

This command will:

• Look for DAG configuration files in dags/*/config.yml
• Execute the DAG inside the running Airflow container

Validate DAG syntax with flake8

actl fix

This will run flake8 linter on the dags/ folder to check for Python syntax issues.

Building from Source

# Build wheel
python -m build

# Install built package
pip install dist/airflow_cli-*.whl

Publishing to PyPI

# Build wheel
python -m build
# Publish to PyPI
pip install twine
twine upload dist/* --username __token__ --password "$PYPI_TOKEN"

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made by the LEMA UFPB team