[airflow] branch master updated: Adds information about PIP being the only official install tool (#13565)

[po...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

potiuk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/airflow.git


The following commit(s) were added to refs/heads/master by this push:
     new 94f39ae  Adds information about PIP being the only official install tool (#13565)
94f39ae is described below

commit 94f39ae0ce17a47c37250b844652e87c73e0231e
Author: Jarek Potiuk <ja...@polidea.com>
AuthorDate: Fri Jan 8 20:30:31 2021 +0100

    Adds information about PIP being the only official install tool (#13565)
    
    Installation with remote constraint files is supported with PIP
    and we are using it in order to maintain constistent set of
    requirements, however we keep getting issues from people using
    poetry and pip-tools who try to install airflow without following
    the official way.
    
    This chapter explains why and sets PIP as the only official
    installation tool supported.
---
 docs/apache-airflow/installation.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/docs/apache-airflow/installation.rst b/docs/apache-airflow/installation.rst
index 9bcb0e7..28b773f 100644
--- a/docs/apache-airflow/installation.rst
+++ b/docs/apache-airflow/installation.rst
@@ -60,6 +60,18 @@ Those "known-to-be-working" constraints are per major/minor python version. You
 files when installing Airflow from PyPI. Note that you have to specify correct Airflow version
 and python versions in the URL.
 
+The official way of installing Airflow is with the ``pip`` tool.
+There was a recent (November 2020) change in resolver, so currently only 20.2.4 version is officially
+supported, although you might have a success with 20.3.3+ version (to be confirmed if all initial
+issues from ``pip`` 20.3.0 release have been fixed in 20.3.3).
+
+While they are some successes with using other tools like `poetry <https://python-poetry.org/>`_ or
+`pip-tools <https://pypi.org/project/pip-tools/>`_, but they do not share the same workflow as
+``pip``- especially when it comes to constraint vs. requirements management.
+Installing via ``Poetry`` or ``pip-tools`` is not currently supported. If you wish to install airflow
+using those tools you should use the constraint files described below and convert them to appropriate
+format and workflow that your tool requires.
+
   **Prerequisites**
 
   On Debian based Linux OS: