turbaszek commented on a change in pull request #9889: URL: https://github.com/apache/airflow/pull/9889#discussion_r457272314
########## File path: CONTRIBUTING.rst ########## @@ -342,76 +342,61 @@ be open to allow several different libraries with the same requirements to be in The problem is that Apache Airflow is a bit of both - application to install and library to be used when you are developing your own operators and DAGs. -This - seemingly unsolvable - puzzle is solved by having pinned requirement files. Those are available -as of airflow 1.10.10. +This - seemingly unsolvable - puzzle is solved by having pinned constraints files. Those are available +as of airflow 1.10.10 and further improved with 1.10.12 (moved to separate orphan branches) -Pinned requirement files ------------------------- +Pinned constraint files +----------------------- By default when you install ``apache-airflow`` package - the dependencies are as open as possible while -still allowing the apache-airflow package to install. This means that 'apache-airflow' package might fail to +still allowing the apache-airflow package to install. This means that ``apache-airflow`` package might fail to install in case a direct or transitive dependency is released that breaks the installation. In such case when installing ``apache-airflow``, you might need to provide additional constraints (for example ``pip install apache-airflow==1.10.2 Werkzeug<1.0.0``) -However we now have ``requirements-python<PYTHON_MAJOR_MINOR_VERSION>.txt`` file generated -automatically and committed in the requirements folder based on the set of all latest working and tested -requirement versions. Those ``requirement-python<PYTHON_MAJOR_MINOR_VERSION>.txt`` files can be used as -constraints file when installing Apache Airflow - either from the sources +However we now have ``constraints-<PYTHON_MAJOR_MINOR_VERSION>.txt`` files generated +automatically and committed to orphan ``constraints-master`` and ``constraint-1-10`` branches based on +the set of all latest working and tested dependency versions. Those +``constraints-<PYTHON_MAJOR_MINOR_VERSION>.txt`` files can be used as +constraints file when installing Apache Airflow - either from the sources: .. code-block:: bash - pip install -e . --constraint requirements/requirements-python3.6.txt + pip install -e . \ + --constraint --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-master/constraints-3.6.txt"; Review comment: ```suggestion --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-master/constraints-3.6.txt"; ``` ########## File path: CONTRIBUTING.rst ########## @@ -342,76 +342,61 @@ be open to allow several different libraries with the same requirements to be in The problem is that Apache Airflow is a bit of both - application to install and library to be used when you are developing your own operators and DAGs. -This - seemingly unsolvable - puzzle is solved by having pinned requirement files. Those are available -as of airflow 1.10.10. +This - seemingly unsolvable - puzzle is solved by having pinned constraints files. Those are available +as of airflow 1.10.10 and further improved with 1.10.12 (moved to separate orphan branches) -Pinned requirement files ------------------------- +Pinned constraint files +----------------------- By default when you install ``apache-airflow`` package - the dependencies are as open as possible while -still allowing the apache-airflow package to install. This means that 'apache-airflow' package might fail to +still allowing the apache-airflow package to install. This means that ``apache-airflow`` package might fail to install in case a direct or transitive dependency is released that breaks the installation. In such case when installing ``apache-airflow``, you might need to provide additional constraints (for example ``pip install apache-airflow==1.10.2 Werkzeug<1.0.0``) -However we now have ``requirements-python<PYTHON_MAJOR_MINOR_VERSION>.txt`` file generated -automatically and committed in the requirements folder based on the set of all latest working and tested -requirement versions. Those ``requirement-python<PYTHON_MAJOR_MINOR_VERSION>.txt`` files can be used as -constraints file when installing Apache Airflow - either from the sources +However we now have ``constraints-<PYTHON_MAJOR_MINOR_VERSION>.txt`` files generated +automatically and committed to orphan ``constraints-master`` and ``constraint-1-10`` branches based on +the set of all latest working and tested dependency versions. Those +``constraints-<PYTHON_MAJOR_MINOR_VERSION>.txt`` files can be used as +constraints file when installing Apache Airflow - either from the sources: .. code-block:: bash - pip install -e . --constraint requirements/requirements-python3.6.txt + pip install -e . \ + --constraint --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-master/constraints-3.6.txt"; -or from the pypi package +or from the pypi package: .. code-block:: bash - pip install apache-airflow --constraint requirements/requirements-python3.6.txt + pip install apache-airflow \ + --constraint --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-master/constraints-3.6.txt"; Review comment: ```suggestion --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-master/constraints-3.6.txt"; ``` ########## File path: CONTRIBUTING.rst ########## @@ -342,76 +342,61 @@ be open to allow several different libraries with the same requirements to be in The problem is that Apache Airflow is a bit of both - application to install and library to be used when you are developing your own operators and DAGs. -This - seemingly unsolvable - puzzle is solved by having pinned requirement files. Those are available -as of airflow 1.10.10. +This - seemingly unsolvable - puzzle is solved by having pinned constraints files. Those are available +as of airflow 1.10.10 and further improved with 1.10.12 (moved to separate orphan branches) -Pinned requirement files ------------------------- +Pinned constraint files +----------------------- By default when you install ``apache-airflow`` package - the dependencies are as open as possible while -still allowing the apache-airflow package to install. This means that 'apache-airflow' package might fail to +still allowing the apache-airflow package to install. This means that ``apache-airflow`` package might fail to install in case a direct or transitive dependency is released that breaks the installation. In such case when installing ``apache-airflow``, you might need to provide additional constraints (for example ``pip install apache-airflow==1.10.2 Werkzeug<1.0.0``) -However we now have ``requirements-python<PYTHON_MAJOR_MINOR_VERSION>.txt`` file generated -automatically and committed in the requirements folder based on the set of all latest working and tested -requirement versions. Those ``requirement-python<PYTHON_MAJOR_MINOR_VERSION>.txt`` files can be used as -constraints file when installing Apache Airflow - either from the sources +However we now have ``constraints-<PYTHON_MAJOR_MINOR_VERSION>.txt`` files generated +automatically and committed to orphan ``constraints-master`` and ``constraint-1-10`` branches based on +the set of all latest working and tested dependency versions. Those +``constraints-<PYTHON_MAJOR_MINOR_VERSION>.txt`` files can be used as +constraints file when installing Apache Airflow - either from the sources: .. code-block:: bash - pip install -e . --constraint requirements/requirements-python3.6.txt + pip install -e . \ + --constraint --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-master/constraints-3.6.txt"; -or from the pypi package +or from the pypi package: .. code-block:: bash - pip install apache-airflow --constraint requirements/requirements-python3.6.txt + pip install apache-airflow \ + --constraint --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-master/constraints-3.6.txt"; This works also with extras - for example: .. code-block:: bash - pip install .[ssh] --constraint requirements/requirements-python3.6.txt + pip install .[ssh] \ + --constraint --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-master/constraints-3.6.txt"; Review comment: ```suggestion --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-master/constraints-3.6.txt"; ``` ########## File path: IMAGES.rst ########## @@ -92,14 +92,14 @@ parameter to Breeze: .. code-block:: bash - ./breeze build-image --python 3.7 --extras=gcp --production-image --install-airflow-version=1.10.9 + ./breeze build-image --python 3.7 --extras=gcp --production-image --install-airflow-version=1.10.12 This will build the image using command similar to: .. code-block:: bash - pip install apache-airflow[sendgrid]==1.10.9 \ - --constraint https://raw.githubusercontent.com/apache/airflow/v1-10-test/requirements/requirements-python3.7.txt + pip install apache-airflow[sendgrid]==1.10.12 \ + --constraint --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-1.10.12/constraints-3.6.txt"; Review comment: ```suggestion --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-1.10.12/constraints-3.6.txt"; ``` ########## File path: IMAGES.rst ########## @@ -109,8 +109,8 @@ parameter to Breeze: .. code-block:: bash - pip install https://github.com/apache/airflow/archive/<tag>.tar.gz#egg=apache-airflow \ - --constraint https://raw.githubusercontent.com/apache/airflow/<tag>/requirements/requirements-python3.7.txt + pip install "https://github.com/apache/airflow/archive/<tag>.tar.gz#egg=apache-airflow" \ + --constraint --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-master/constraints-3.6.txt"; Review comment: ```suggestion --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-master/constraints-3.6.txt"; ``` ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
