Skip to main content

A lightweight Python package to simplify the installation of Apache Airflow effortlessly.

Project description

Airflow Installer

PyPI GitHub

A command-line tool to simplify the installation of Apache Airflow in a virtual environment.

Features

  • Install Apache Airflow with optional dependencies in a virtual environment.
  • Automatically detect the latest version of Apache Airflow from PyPI.
  • Manage version constraints using constraints files.
  • Easy-to-use command-line interface (CLI) for seamless installation.

Installation

You can install airflow-installer using pip:

pip install airflow-installer

Options

 Usage: airflow_installer [OPTIONS]

╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --version                                     TEXT  Apache Airflow version to install. Defaults to latest. [default: 2.6.3]                                                                                        │
│ --constraints-url                             TEXT  URL of the constraints file. Defaults to latest version constraints.                                                                                           │
│ --extras                                      TEXT  Extras or additional requirements to install with Apache Airflow.                                                                                              │
│ --requirements                                TEXT  Path to a requirements.txt file to be used during installation.                                                                                                │
│ --venv-path                                   TEXT  Path where the virtual environment will be created [default: .venv/airflow]                                                                                    │
│ --recreate-venv         --no-recreate-venv          Recreate virtual environment if it already exists. [default: no-recreate-venv]                                                                                 │
│ --verbose               --no-verbose                Enable verbose debugging output. [default: no-verbose]                                                                                                         │
│ --install-completion                                Install completion for the current shell.                                                                                                                      │
│ --show-completion                                   Show completion for the current shell, to copy it or customize the installation.                                                                               │
│ --help                                              Show this message and exit.                                                                                                                                    │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Usage

# Install the latest version of Apache Airflow in the default virtual environment
airflow-installer

# Install a specific version of Apache Airflow in a custom virtual environment
airflow-installer --version 2.6.3 --venv-path .venv/my-airflow

# Install Apache Airflow with specific extras and constraints
airflow-installer --version 2.5.2 --extras "[celery,crypto]" --constraints-url "https://raw.githubusercontent.com/apache/airflow/constraints-2.5.2/constraints-3.7.txt"

# Install Apache Airflow using a requirements.txt file
airflow-installer --version 2.6.0 --requirements requirements.txt

# Recreate the virtual environment if it already exists
airflow-installer --recreate-venv

# Enable verbose output for debugging
airflow-installer --verbose

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airflow_installer-0.1.0.tar.gz (7.9 kB view hashes)

Uploaded Source

Built Distribution

airflow_installer-0.1.0-py3-none-any.whl (8.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page