Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions airflow-core/docs/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,28 @@ via extras and providers.
When you install Airflow, you need to :doc:`setup the database <setting-up-the-database>` which must
also be kept updated when Airflow is upgraded.

Local start for development and testing
'''''''''''''''''''''''''''''''''''''''

You just want to try Apache Airflow without all production complexity? If you have ``pipx`` installed,
you can install Airflow directly from PyPI with the command below:

.. code-block:: bash

pipx run apache-airflow standalone

Alternatively similar with Astral ``uv``:

.. code-block:: bash

uvx apache-airflow standalone

Which starts a minimal system with an auto-generated admin password and SQLite database, so you can
start using Airflow right away. This is a great way to get familiar with Airflow and try it out
without the need to set up a complex environment.

Note that the standalone mode is not for production purposes. But it is a simple start for a local development.

Using released sources
''''''''''''''''''''''

Expand Down
28 changes: 26 additions & 2 deletions airflow-core/docs/installation/installing-from-pypi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,32 @@ Installation from PyPI
This page describes installations using the ``apache-airflow`` package `published in
PyPI <https://pypi.org/project/apache-airflow/>`__.

Installation tools
''''''''''''''''''
Installation via ``pipx`` or ``uv`` as tool
'''''''''''''''''''''''''''''''''''''''''''

For a local development and testing environment, you can install and run Apache Airflow directly from PyPI.

If you use ``pipx`` you can run directly from PyPI with the command below:

.. code-block:: bash

pipx run "apache-airflow==|version|" standalone

Via Astral ``uv`` it is possible to install from PyPI using:

.. code-block:: bash

uv tool install "apache-airflow==|version|"

Additionally to jump-start using it you can also use the shortcut via ``uvx`` command and directly run it without installing it first:

.. code-block:: bash

uvx apache-airflow standalone


Installation in your environment
''''''''''''''''''''''''''''''''

Only ``pip`` and ``uv`` installation is currently officially supported.

Expand Down
4 changes: 4 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ dependencies = [

packages = []

[project.scripts]
# Definition allowing direct execution via `uvx apache-airflow ...`
apache-airflow = "airflow.__main__:main"

[project.optional-dependencies]
# Automatically generated airflow optional dependencies (update_airflow_pyproject_toml.py)
"all-core" = [
Expand Down
Loading