You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: airflow-core/docs/start.rst
+37-3Lines changed: 37 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,9 +26,9 @@ This quick start guide will help you bootstrap an Airflow standalone instance on
26
26
27
27
Successful installation requires a Python 3 environment. Starting with Airflow 3.1.0, Airflow supports Python 3.10, 3.11, 3.12, 3.13.
28
28
29
-
Officially supported installation methods is with``pip`.
29
+
Officially supported installation methods is with``pip`` or ``uv``.
30
30
31
-
Run ``pip install apache-airflow[EXTRAS]==AIRFLOW_VERSION --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-AIRFLOW_VERSION/constraints-PYTHON_VERSION.txt"``, for example ``pip install "apache-airflow[celery]==3.0.0" --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-3.0.0/constraints-3.10.txt"`` to install Airflow in a reproducible way.
31
+
Run ``pip install apache-airflow[EXTRAS]==AIRFLOW_VERSION --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-AIRFLOW_VERSION/constraints-PYTHON_VERSION.txt"``, for example ``pip install "apache-airflow[celery]==3.0.0" --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-3.0.0/constraints-3.10.txt"`` to install Airflow in a reproducible way. You can also use - much faster - ``uv`` - by adding ``uv`` before the command.
32
32
33
33
34
34
@@ -43,6 +43,12 @@ This quick start guide will help you bootstrap an Airflow standalone instance on
43
43
This guide will help you quickly set up Apache Airflow using ``uv``, a fast and modern tool for managing Python environments and dependencies. ``uv`` makes the installation process easy and provides a
44
44
smooth setup experience.
45
45
46
+
If you are on Windows, you have to use WSL2 (Linux environment for Windows).
47
+
48
+
.. code-block:: bash
49
+
50
+
wsl --install
51
+
46
52
1. **Set Airflow Home (optional)**:
47
53
48
54
Airflow requires a home directory, and uses ``~/airflow`` by default, but you can set a different location if you prefer. The ``AIRFLOW_HOME`` environment variable is used to inform Airflow of the desired location. This step of setting the environment variable should be done before installing Airflow so that the installation process knows where to store the necessary files.
@@ -51,7 +57,7 @@ This quick start guide will help you bootstrap an Airflow standalone instance on
51
57
52
58
export AIRFLOW_HOME=~/airflow
53
59
54
-
2. Install Airflow Using uv:
60
+
2. Install Airflow in a virtual environment using ``uv`` since it is faster alternative that creates the ``venv`` automatically implicitly for you. It is efficient alternative to using ``pip`` and ``venv``.
55
61
56
62
.. rst-class:: centered
57
63
@@ -61,6 +67,34 @@ This quick start guide will help you bootstrap an Airflow standalone instance on
61
67
For creating virtual environment with ``uv``, refer to the documentation here:
62
68
`Creating and Maintaining Local virtual environment with uv <https://github.com/apache/airflow/blob/main/contributing-docs/07_local_virtualenv.rst#creating-and-maintaining-local-virtualenv-with-uv-recommended>`_
63
69
70
+
For installation using ``pip`` and ``venv``, carry out following steps:
71
+
.. code-block:: bash
72
+
73
+
# For Windows after WSL2 install, restart computer, then in WSL Ubuntu terminal
74
+
sudo apt update
75
+
sudo apt install python3-pip python3-venv
76
+
77
+
bash # Go to Linux home directory (not Windows mount)
78
+
cd~
79
+
80
+
# Create airflow directory
81
+
mkdir -p ~/airflow
82
+
cd~airflow
83
+
84
+
# Create virtual environment
85
+
python3 -m venv airflow_venv
86
+
87
+
# Activate
88
+
source airflow_venv/bin/activate
89
+
90
+
# Upgrade pip
91
+
pip install --upgrade pip
92
+
93
+
# Install Airflow with correct Python version constraints
0 commit comments