[GitHub] [airflow] potiuk commented on pull request #22916: Clarify breeze install message re pipx vs `./breeze`

[GitBox <gi...@apache.org>]

potiuk commented on PR #22916:
URL: https://github.com/apache/airflow/pull/22916#issuecomment-1095425532

   Hmmm. That's not really correct. The new `breeze` actually REQUIRES `pipx` . This is the only supported method of installation. The `./breeze` script is merely wrapper around it when you look closely.
   
   Maybe the message should be clearer but it's not either-or. The `./breeze` script is temporary to ease people to migrate but we will remove it eventually.
   
   We thought and tried quite some time about whether to support two ways of running `breeze` but due to autocomplete requiring installing the `airflow-breeze` as package AND having `breeze` on the path - we chose `pipx` as the only way to install the new breeze.
   
   This has been captured in ADR 10 here with the detailed reasoning and invalidating earlier ADR 3 where we did not decide about the way of installation until we learn more: https://github.com/apache/airflow/blob/main/dev/breeze/doc/adr/0010-use-pipx-to-install-breeze.md (includes context and consequences).
   
   If you do not use `pipx`, there are few consequnces. Most notable is that "self-upgrade" command will not work. It assumes breeze is installed with `pipx` and will attempt to use `pipx` to upgrade it to get latest dependencies installed. It even allows you to reinstall `breeze` from a different source tree (because it might be that you have version 2.3 and main where `main` breeze will not work on `2.3` branch. Breeze warns the user if you try to use it from a wrong source tree and offers you to reinstall it. 
   
   This all is strongly rooted with the  assumption that breeze is installed with `pipx`.


-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org