Airflow Tutor Agent 🤖✈️
A complete beginner-focused AI Tutor designed to help freshers step-by-step through setting up Apache Airflow 3.x locally on Windows, macOS, or Linux.
Project Goal
This agent doesn't just run a bash script to install Airflow. It stops, explains what each command does, asks the student to verify the output, and provides an immediate rule-based troubleshooting engine if they hit a wall. Finally, it teaches them core Airflow concepts and walks them through running their first beginner DAG.
Features
- Deterministic Preflight Checks: Verifies Python, Docker, Port 8080.
- Auto-Recommendation Engine: Recommends Docker Compose for Windows and pip + venv for macOS/Linux.
- Guided Setup Mode: Gives short 1-line commands and waits for confirmation.
- Troubleshooting Engine: Catches
Exit Code 137,Port 8080 in use,Python version mismatch. - Teaching Mode: Explains
DAGs,Tasks,Schedulers, and runs a sample payload.
How to Run it Locally
- Clone this repository (or copy the generated folder).
- Install Python 3.8+ if you haven't already.
- Open a terminal and navigate to this folder.
- Run:
python -m venv venv
# Windows: .\venv\Scripts\activate
# Mac/Linux: source venv/bin/activate
pip install -r requirements.txt
- Start the Tutor!
python -m app.main start
Preflight Only
If you just want to run the system checks without launching the interactive tutor:
python -m app.main check
Or execute the raw shell scripts in /scripts.
Architecture
See docs/architecture.md for a full breakdown. It uses Typer and Rich for a beautiful CLI interface.
Support OS & Methods
- Windows: Target method -> Docker Compose
- macOS / Linux: Target method -> pip + venv (standalone)
- Advanced Optional: Kubernetes with Helm
Security Notes
This is meant strictly for local learning on localhost:8080.
- Do not expose port 8080 to the public internet.
- Never commit
airflow.cfgor.envfiles with generated secret keys to GitHub. - Airflow's standalone password defaults are NOT safe for production!
Release files for airflow-tutor-agent 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| airflow_tutor_agent-1.0.0.tar.gz | 20.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| airflow_tutor_agent-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 36.1 kB
Release files / airflow_tutor_agent-1.0.0.tar.gz
| Download URL | airflow_tutor_agent-1.0.0.tar.gz |
|---|---|
| Size | 20.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a8c06c920ed9a38bfe71d8f8fd130d975b02e8dc7ea79a4e5320b1ab9ac313e0
|
|
BLAKE2b-256 checksum How to use checksums |
2d05bc3fa6e730107a225c71ed1adb2cb347b0b21ba42907cd5caaac96210c75
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.2
|
Release files / airflow_tutor_agent-1.0.0-py3-none-any.whl
| Download URL | airflow_tutor_agent-1.0.0-py3-none-any.whl |
|---|---|
| Size | 15.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
213fa4cf1407444fad410389e0c0309981c15c65e1187340ab0235d2e6640f6f
|
|
BLAKE2b-256 checksum How to use checksums |
f5c09eaaeb1a545c53bc967a3078e31f488d29063b30dd384620766111e702f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.2
|