Skip to content

Commit

Permalink
Clarify that bundle extras should not be used for PyPi installs (#23697)
Browse files Browse the repository at this point in the history
The bundle extras we have are only used for development and they
should not be used to install airflow from PyPI. This update
to documentation clarifies it.

Closes: #23692
(cherry picked from commit 310002e)
  • Loading branch information
potiuk authored and ephraimbuddy committed May 21, 2022
1 parent e3fd257 commit 32aa1ac
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/apache-airflow/extra-packages-ref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,12 @@ Those are extras that provide support for integration with external systems via
Bundle extras
-------------

Those are extras that install one ore more extras as a bundle.
Those are extras that install one ore more extras as a bundle. Note that those extras should only be used for "development" version
of Airflow - i.e. when Airflow is installed from sources. Because of the way how bundle extras are constructed they might not
work when airflow is installed from 'PyPI`.

If you want to install Airflow from PyPI with "all" extras (which should basically be never needed - you almost never need all extras from Airflow),
you need to list explicitly all the non-bundle extras that you want to install.

+---------------------+-----------------------------------------------------+------------------------------------------------------------------------+
| extra | install command | enables |
Expand Down

0 comments on commit 32aa1ac

Please sign in to comment.