Skip to content

Commit d59853a

Browse files
potiukkaxil
authored andcommitted
Update documentation about PIP 20.3 incompatibility
1 parent 9312a28 commit d59853a

9 files changed

+128
-5
lines changed

CONTRIBUTING.rst

+24-2
Original file line numberDiff line numberDiff line change
@@ -541,6 +541,14 @@ extras can be specified after the usual pip install - for example
541541
installs all development dependencies. There is also ``devel_ci`` that installs
542542
all dependencies needed in the CI environment.
543543

544+
.. note::
545+
On 30th of November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver.
546+
This resolver does not yet work with Apache Airflow and might leads to errors in installation -
547+
depends on your choice of extras. In order to install Airflow you need to either downgrade
548+
pip to version 20.2.4 ``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
549+
``--use-deprecated legacy-resolver`` to your pip install command.
550+
551+
544552
This is the full list of those extras:
545553

546554
.. START EXTRAS HERE
@@ -591,6 +599,14 @@ the other provider package you can install it adding [extra] after the
591599
``pip install apache-airflow-backport-providers-google[amazon]`` in case you want to use GCP
592600
transfer operators from Amazon ECS.
593601

602+
.. note::
603+
On 30th of November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver.
604+
This resolver does not yet work with Apache Airflow and might leads to errors in installation -
605+
depends on your choice of extras. In order to install Airflow you need to either downgrade
606+
pip to version 20.2.4 ``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
607+
``--use-deprecated legacy-resolver`` to your pip install command.
608+
609+
594610
If you add a new dependency between different providers packages, it will be detected automatically during
595611
pre-commit phase and pre-commit will fail - and add entry in dependencies.json so that the package extra
596612
dependencies are properly added when package is installed.
@@ -671,6 +687,14 @@ install in case a direct or transitive dependency is released that breaks the in
671687
when installing ``apache-airflow``, you might need to provide additional constraints (for
672688
example ``pip install apache-airflow==1.10.2 Werkzeug<1.0.0``)
673689

690+
.. note::
691+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
692+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
693+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
694+
``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
695+
``--use-deprecated legacy-resolver`` to your pip install command.
696+
697+
674698
However we now have ``constraints-<PYTHON_MAJOR_MINOR_VERSION>.txt`` files generated
675699
automatically and committed to orphan ``constraints-master`` and ``constraint-1-10`` branches based on
676700
the set of all latest working and tested dependency versions. Those
@@ -682,15 +706,13 @@ constraints file when installing Apache Airflow - either from the sources:
682706
pip install -e . \
683707
--constraint "https://raw.githubusercontent.com/apache/airflow/constraints-1-10/constraints-3.6.txt"
684708
685-
686709
or from the pypi package:
687710

688711
.. code-block:: bash
689712
690713
pip install apache-airflow \
691714
--constraint "https://raw.githubusercontent.com/apache/airflow/constraints-1-10/constraints-3.6.txt"
692715
693-
694716
This works also with extras - for example:
695717

696718
.. code-block:: bash

IMAGES.rst

+8
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,14 @@ This will build the image using command similar to:
125125
apache-airflow[async,aws,azure,celery,dask,elasticsearch,gcp,kubernetes,mysql,postgres,redis,slack,ssh,statsd,virtualenv,presto]==1.10.13 \
126126
--constraint "https://raw.githubusercontent.com/apache/airflow/constraints-1.10.13/constraints-3.6.txt"
127127
128+
.. note::
129+
On 30th of November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver.
130+
This resolver does not yet work with Apache Airflow and might leads to errors in installation -
131+
depends on your choice of extras. In order to install Airflow you need to either downgrade
132+
pip to version 20.2.4 ``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
133+
``--use-deprecated legacy-resolver`` to your pip install command.
134+
135+
128136
You can also build production images from specific Git version via providing ``--install-airflow-reference``
129137
parameter to Breeze (this time constraints are taken from the ``constraints-master`` branch which is the
130138
HEAD of development for constraints):

INSTALL

+23-3
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,36 @@ source PATH_TO_YOUR_VENV/bin/activate
3131
# [required] building and installing by pip (preferred)
3232
pip install .
3333

34-
# or directly
34+
NOTE!
35+
36+
On 30th of November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver.
37+
This resolver does not yet work with Apache Airflow and might leads to errors in installation -
38+
depends on your choice of extras. In order to install Airflow you need to either downgrade
39+
pip to version 20.2.4 ``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
40+
``--use-deprecated legacy-resolver`` to your pip install command.
41+
42+
43+
# or you can install it directly via setup.py
3544
python setup.py install
3645

46+
3747
# You can also install recommended version of the dependencies by using
3848
# constraint-python<PYTHON_MAJOR_MINOR_VERSION>.txt files as constraint file. This is needed in case
3949
# you have problems with installing the current requirements from PyPI.
40-
# There are different constraint files for different python versions. For example"
50+
# There are different constraint files for different python versions and you shopuld choose the
51+
# version of constraints specific for your version.
52+
# For example:
4153

4254
pip install . \
43-
--constraint "https://raw.githubusercontent.com/apache/airflow/constraints-master/constraints-3.6.txt"
55+
--constraint "https://raw.githubusercontent.com/apache/airflow/constraints-1.10.14/constraints-3.6.txt"
56+
57+
58+
.. note::
59+
On 30th of November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver.
60+
This resolver does not yet work with Apache Airflow and might leads to errors in installation -
61+
depends on your choice of extras. In order to install Airflow you need to either downgrade
62+
pip to version 20.2.4 ``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
63+
``--use-deprecated legacy-resolver`` to your pip install command.
4464

4565
# You can also install Airflow with extras specified. The list of available extras:
4666
# START EXTRAS HERE

LOCAL_VIRTUALENV.rst

+8
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,14 @@ To create and initialize the local virtualenv:
118118
119119
pip install -U -e ".[devel,<OTHER EXTRAS>]" # for example: pip install -U -e ".[devel,gcp,postgres]"
120120
121+
.. note::
122+
On 30th of November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver.
123+
This resolver does not yet work with Apache Airflow and might leads to errors in installation -
124+
depends on your choice of extras. In order to install Airflow you need to either downgrade
125+
pip to version 20.2.4 ``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
126+
``--use-deprecated legacy-resolver`` to your pip install command.
127+
128+
121129
In case you have problems with installing airflow because of some requirements are not installable, you can
122130
try to install it with the set of working constraints (note that there are different constraint files
123131
for different python versions:

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,15 @@ pip install apache-airflow==1.10.13 \
122122
--constraint "https://raw.githubusercontent.com/apache/airflow/constraints-1.10.13/constraints-3.7.txt"
123123
```
124124

125+
**NOTE!!!**
126+
127+
On 30th of November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver.
128+
This resolver does not yet work with Apache Airflow and might leads to errors in installation -
129+
depends on your choice of extras. In order to install Airflow you need to either downgrade
130+
pip to version 20.2.4 `pip upgrade --pip==20.2.4` or, in case you use Pip 20.3, you need to add option
131+
`--use-deprecated legacy-resolver` to your pip install command.
132+
133+
125134
2. Installing with extras (for example postgres,gcp)
126135
```bash
127136
pip install apache-airflow[postgres,gcp]==1.10.13 \

docs/installation.rst

+16
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,14 @@ and python versions in the URL.
5858
# For example: https://raw.githubusercontent.com/apache/airflow/constraints-1.10.13/constraints-3.6.txt
5959
pip install "apache-airflow==${AIRFLOW_VERSION}" --constraint "${CONSTRAINT_URL}"
6060
61+
62+
.. note::
63+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
64+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
65+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
66+
``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
67+
``--use-deprecated legacy-resolver`` to your pip install command.
68+
6169
2. Installing with extras (for example postgres, google)
6270

6371
.. code-block:: bash
@@ -68,6 +76,14 @@ and python versions in the URL.
6876
pip install "apache-airflow[postgres,google]==${AIRFLOW_VERSION}" --constraint "${CONSTRAINT_URL}"
6977
7078
79+
.. note::
80+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
81+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
82+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
83+
``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
84+
``--use-deprecated legacy-resolver`` to your pip install command.
85+
86+
7187
You need certain system level requirements in order to install Airflow. Those are requirements that are known
7288
to be needed for Linux system (Tested on Ubuntu Buster LTS) :
7389

docs/metrics.rst

+8
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,14 @@ First you must install statsd requirement:
3131
3232
pip install 'apache-airflow[statsd]'
3333
34+
.. note::
35+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
36+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
37+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
38+
``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
39+
``--use-deprecated legacy-resolver`` to your pip install command.
40+
41+
3442
Add the following lines to your configuration file e.g. ``airflow.cfg``
3543

3644
.. code-block:: ini

docs/security.rst

+23
Original file line numberDiff line numberDiff line change
@@ -320,6 +320,13 @@ To use kerberos authentication, you must install Airflow with the ``kerberos`` e
320320
321321
pip install 'apache-airflow[kerberos]'
322322
323+
.. note::
324+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
325+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
326+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
327+
``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
328+
``--use-deprecated legacy-resolver`` to your pip install command.
329+
323330
OAuth Authentication
324331
--------------------
325332
@@ -359,6 +366,14 @@ To use GHE authentication, you must install Airflow with the ``github_enterprise
359366
360367
pip install 'apache-airflow[github_enterprise]'
361368
369+
.. note::
370+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
371+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
372+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
373+
``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
374+
``--use-deprecated legacy-resolver`` to your pip install command.
375+
376+
362377
Setting up GHE Authentication
363378
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
364379
@@ -414,6 +429,14 @@ To use Google authentication, you must install Airflow with the ``google_auth``
414429
415430
pip install 'apache-airflow[google_auth]'
416431
432+
.. note::
433+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
434+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
435+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
436+
``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
437+
``--use-deprecated legacy-resolver`` to your pip install command.
438+
439+
417440
Setting up Google Authentication
418441
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
419442

docs/start.rst

+9
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,15 @@ The installation is quick and straightforward.
4343
4444
# visit localhost:8080 in the browser and enable the example dag in the home page
4545
46+
47+
.. note::
48+
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
49+
does not yet work with Apache Airflow and might leads to errors in installation - depends on your choice
50+
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
51+
``pip upgrade --pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
52+
``--use-deprecated legacy-resolver`` to your pip install command.
53+
54+
4655
Upon running these commands, Airflow will create the ``$AIRFLOW_HOME`` folder
4756
and lay an "airflow.cfg" file with defaults that get you going fast. You can
4857
inspect the file either in ``$AIRFLOW_HOME/airflow.cfg``, or through the UI in

0 commit comments

Comments
 (0)