airflow-cli 0.1.0__tar.gz → 0.1.1__tar.gz

airflow_cli-0.1.1/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: airflow-cli
+Version: 0.1.1
+Summary: CLI para facilitar o setup de Airflow com Docker.
+Author-email: LEMA-UFPB <ufpb.lema@gmail.com>
+License-Expression: MIT
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: simple-term-menu>=1.0.0
+Requires-Dist: requests>=2.25.0
+Requires-Dist: flake8>=4.0.0
+Requires-Dist: pyyaml>=5.4.0
+Dynamic: license-file
+
+# 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)
+
+```bash
+pip install airflow-cli
+```
+
+
+## Quick Start
+
+### 1. Start Airflow Environment
+
+```bash
+airflow-cli up
+```
+
+This command will:
+- Check Docker installation and environment
+- Download the latest docker-compose.yml from LEMA UFPB repository
+- 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
+
+```bash
+airflow-cli down
+```
+
+## Usage
+
+### Available Commands
+
+```bash
+# Start Docker environment
+airflow-cli up
+
+# Stop Docker environment  
+airflow-cli down
+
+# Run Airflow DAG inside Docker
+airflow-cli run-dag
+
+# Run flake8 linter on DAGs
+airflow-cli fix-code
+
+# Show help
+airflow-cli --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`:
+```yaml
+args:
+  id: "my_dag_id"
+```
+
+### Testing DAGs
+
+#### Run a DAG inside Docker
+```bash
+airflow-cli run-dag
+```
+
+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
+```bash
+airflow-cli fix-code
+```
+
+This will run flake8 linter on the `dags/` folder to check for Python syntax issues.
+
+### Building from Source
+
+```bash
+# Build wheel
+python -m build
+
+# Install built package
+pip install dist/airflow_docker_helper-*.whl
+```
+
+## Publishing to PyPI
+```bash
+# Build wheel
+python -m build
+# Publish to PyPI
+twine upload dist/*
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+
+---
+
+Made with ❤️ by the LEMA UFPB team

airflow_cli-0.1.1/README.md

@@ -0,0 +1,141 @@
+# 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)
+
+```bash
+pip install airflow-cli
+```
+
+
+## Quick Start
+
+### 1. Start Airflow Environment
+
+```bash
+airflow-cli up
+```
+
+This command will:
+- Check Docker installation and environment
+- Download the latest docker-compose.yml from LEMA UFPB repository
+- 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
+
+```bash
+airflow-cli down
+```
+
+## Usage
+
+### Available Commands
+
+```bash
+# Start Docker environment
+airflow-cli up
+
+# Stop Docker environment  
+airflow-cli down
+
+# Run Airflow DAG inside Docker
+airflow-cli run-dag
+
+# Run flake8 linter on DAGs
+airflow-cli fix-code
+
+# Show help
+airflow-cli --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`:
+```yaml
+args:
+  id: "my_dag_id"
+```
+
+### Testing DAGs
+
+#### Run a DAG inside Docker
+```bash
+airflow-cli run-dag
+```
+
+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
+```bash
+airflow-cli fix-code
+```
+
+This will run flake8 linter on the `dags/` folder to check for Python syntax issues.
+
+### Building from Source
+
+```bash
+# Build wheel
+python -m build
+
+# Install built package
+pip install dist/airflow_docker_helper-*.whl
+```
+
+## Publishing to PyPI
+```bash
+# Build wheel
+python -m build
+# Publish to PyPI
+twine upload dist/*
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+
+---
+
+Made with ❤️ by the LEMA UFPB team

{airflow_cli-0.1.0 → airflow_cli-0.1.1}/airflow_cli/cli.py

@@ -3,12 +3,14 @@ import logging
 import sys
 
 from .env_utils import ensure_venv, is_in_venv
-from .os_utils import check_docker, check_os, update_docker_compose
+from .os_utils import check_docker, check_os
 from .docker_utils import docker_up, docker_down, run_dag, fix_python_code
 
-logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
+logging.basicConfig(level=logging.INFO,
+                    format='%(asctime)s - %(levelname)s - %(message)s')
 log = logging.getLogger(__name__)
 
+
 def main():
     parser = argparse.ArgumentParser(description="Airflow Docker Helper CLI")
     subparsers = parser.add_subparsers(dest="command")
@@ -30,16 +32,14 @@ def main():
     # Pré-checks antes de qualquer comando
     ensure_venv()
     if not is_in_venv():
-        log.warning("⚠️ Not running inside virtual environment. Interpreter: %s", sys.executable)
-
-
+        log.warning(
+            "⚠️ Not running inside virtual environment. Interpreter: %s", sys.executable)
 
     if not check_docker():
         log.error("❌ Docker not ready.")
         sys.exit(1)
 
     check_os()
-    update_docker_compose()
 
     # Execução dos comandos
     if args.command == "up":
@@ -52,4 +52,3 @@ def main():
         fix_python_code()
     else:
         parser.print_help()
-

{airflow_cli-0.1.0 → airflow_cli-0.1.1}/airflow_cli/docker_utils.py

@@ -2,17 +2,23 @@ import subprocess
 import logging
 from glob import glob
 import yaml
+import os
 
 log = logging.getLogger(__name__)
 
 def docker_up():
     log.info("🐳 Starting Docker environment...")
-    subprocess.run(["docker", "compose", "up", "-d"], check=True)
-    log.info("✅ Docker environment is ready.")
+    env = os.environ.copy()
+    env["AIRFLOW_UID"] = "50000"
+    
+    compose_file = os.path.join(os.path.dirname(__file__), "docker-compose.yml")
+    subprocess.run(["docker", "compose", "-f", compose_file, "up", "-d"], env=env, check=True)
+    log.info("✅ Docker environment is ready: http://localhost:8080")
 
 def docker_down():
     log.info("🐳 Stopping Docker environment...")
-    subprocess.run(["docker", "compose", "down"], check=False)
+    compose_file = os.path.join(os.path.dirname(__file__), "docker-compose.yml")
+    subprocess.run(["docker", "compose", "-f", compose_file, "down"], check=False)
 
 def run_dag():
     log.info("🚀 Running DAG in Docker...")

{airflow_cli-0.1.0 → airflow_cli-0.1.1}/airflow_cli/menu.py

@@ -7,6 +7,7 @@ from .os_utils import check_os, update_docker_compose, check_docker
 
 log = logging.getLogger(__name__)
 
+
 def show_menu():
     options = [
         "🐳 Docker Environment Up",
@@ -20,21 +21,17 @@ def show_menu():
     return options[choice] if choice is not None else None
 
 
-
 def run():
     ensure_venv()
     if not is_in_venv():
         log.warning("⚠️ Not running inside the virtual environment.")
         log.warning(f"Interpreter: {sys.executable}")
 
-
-
     if not check_docker():
         log.error("❌ Docker is not ready.")
         return
 
     check_os()
-    update_docker_compose()
 
     while True:
         option = show_menu()

{airflow_cli-0.1.0 → airflow_cli-0.1.1}/airflow_cli/os_utils.py

@@ -33,15 +33,3 @@ def check_docker():
         log.error(f"❌ Docker check failed: {e}")
         return False
 
-def update_docker_compose():
-    """Copy docker-compose.yml from package to current directory if it doesn't exist"""
-    if not os.path.exists("docker-compose.yml"):
-        try:
-            # Get the docker-compose.yml from the package
-            source = pkg_resources.resource_filename('airflow_docker', 'docker-compose.yml')
-            shutil.copy2(source, "docker-compose.yml")
-            log.info("✅ docker-compose.yml copied to current directory.")
-        except Exception as e:
-            log.error(f"❌ Failed to copy docker-compose.yml: {e}")
-    else:
-        log.info("✅ docker-compose.yml already exists.")

airflow_cli-0.1.1/airflow_cli.egg-info/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: airflow-cli
+Version: 0.1.1
+Summary: CLI para facilitar o setup de Airflow com Docker.
+Author-email: LEMA-UFPB <ufpb.lema@gmail.com>
+License-Expression: MIT
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: simple-term-menu>=1.0.0
+Requires-Dist: requests>=2.25.0
+Requires-Dist: flake8>=4.0.0
+Requires-Dist: pyyaml>=5.4.0
+Dynamic: license-file
+
+# 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)
+
+```bash
+pip install airflow-cli
+```
+
+
+## Quick Start
+
+### 1. Start Airflow Environment
+
+```bash
+airflow-cli up
+```
+
+This command will:
+- Check Docker installation and environment
+- Download the latest docker-compose.yml from LEMA UFPB repository
+- 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
+
+```bash
+airflow-cli down
+```
+
+## Usage
+
+### Available Commands
+
+```bash
+# Start Docker environment
+airflow-cli up
+
+# Stop Docker environment  
+airflow-cli down
+
+# Run Airflow DAG inside Docker
+airflow-cli run-dag
+
+# Run flake8 linter on DAGs
+airflow-cli fix-code
+
+# Show help
+airflow-cli --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`:
+```yaml
+args:
+  id: "my_dag_id"
+```
+
+### Testing DAGs
+
+#### Run a DAG inside Docker
+```bash
+airflow-cli run-dag
+```
+
+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
+```bash
+airflow-cli fix-code
+```
+
+This will run flake8 linter on the `dags/` folder to check for Python syntax issues.
+
+### Building from Source
+
+```bash
+# Build wheel
+python -m build
+
+# Install built package
+pip install dist/airflow_docker_helper-*.whl
+```
+
+## Publishing to PyPI
+```bash
+# Build wheel
+python -m build
+# Publish to PyPI
+twine upload dist/*
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+
+---
+
+Made with ❤️ by the LEMA UFPB team

{airflow_cli-0.1.0 → airflow_cli-0.1.1}/airflow_cli.egg-info/SOURCES.txt

@@ -3,7 +3,6 @@ README.md
 pyproject.toml
 airflow_cli/__init__.py
 airflow_cli/cli.py
-airflow_cli/docker-compose.yml
 airflow_cli/docker_utils.py
 airflow_cli/env_utils.py
 airflow_cli/menu.py

{airflow_cli-0.1.0 → airflow_cli-0.1.1}/pyproject.toml

@@ -1,10 +1,10 @@
 [project]
 name = "airflow-cli"
-version = "0.1.0"
+version = "0.1.1"
 description = "CLI para facilitar o setup de Airflow com Docker."
 readme = "README.md"
 requires-python = ">=3.7"
-license = {text = "MIT"}
+license = "MIT"
 authors = [{ name="LEMA-UFPB", email="ufpb.lema@gmail.com" }]
 dependencies = [
   "simple-term-menu>=1.0.0",
@@ -19,9 +19,6 @@ airflow-cli = "airflow_cli.cli:main"
 [tool.setuptools]
 packages = ["airflow_cli"]
 
-[tool.setuptools.package-data]
-airflow_cli = ["docker-compose.yml"]
-
 [build-system]
 requires = ["setuptools", "wheel"]
 build-backend = "setuptools.build_meta"