amoghrajesh commented on code in PR #35101:
URL: https://github.com/apache/airflow/pull/35101#discussion_r1367746460
##########
BREEZE.rst:
##########
@@ -2649,3 +2649,50 @@ This will also remove breeze from the folder:
``${HOME}.local/bin/``
.. code-block:: bash
pipx uninstall apache-airflow-breeze
+
+
+Debugging/developing Breeze
+===========================
+
+Breeze can be quite easily debugged with PyCharm/VSCode or any other IDE - but
it might be less discoverable
+if you never tested modules and if you do not know how to bypass version check
of breeze.
+
+For testing, you can create your own virtual environment, or use the one that
``pipx`` created for you if you
+already installed breeze following the recommended ``pipx install -e
./dev/breeze`` command.
+
+For local virtualenv, you can use ``pyenv`` or any other virtualenv wrapper.
For example with ``pyenv``,
+you can use ``pyenv virtualenv 3.8.6 airflow-breeze`` to create virtualenv
called ``airflow-breeze``
+with Python 3.8.6. Then you can use ``pyenv activate airflow-breeze`` to
activate it and install breeze
+in editable mode with ``pip install -e ./dev/breeze``.
+
+For ``pipx`` virtualenv, you can use the virtualenv that ``pipx`` created for
you. You can find the name
+where ``pipx`` keeps their venvs via ``pipx list`` command. Usually it is
+``${HOME}/.local/pipx/venvs/apache-airflow-breeze`` where ``$HOME`` is your
home directory.
+
+The venv can be used for running breeze tests and for debugging breeze. While
running tests should
+be usually "out-of-the-box" for most IDEs, once you configure ``./dev/breeze``
project to use the venv,
+Running/debugging a particular breeze command you want to debug might be a bit
more tricky.
Review Comment:
Super nit: running/debugging
You can ignore as well
##########
BREEZE.rst:
##########
@@ -2649,3 +2649,50 @@ This will also remove breeze from the folder:
``${HOME}.local/bin/``
.. code-block:: bash
pipx uninstall apache-airflow-breeze
+
+
+Debugging/developing Breeze
+===========================
+
+Breeze can be quite easily debugged with PyCharm/VSCode or any other IDE - but
it might be less discoverable
+if you never tested modules and if you do not know how to bypass version check
of breeze.
+
+For testing, you can create your own virtual environment, or use the one that
``pipx`` created for you if you
+already installed breeze following the recommended ``pipx install -e
./dev/breeze`` command.
+
+For local virtualenv, you can use ``pyenv`` or any other virtualenv wrapper.
For example with ``pyenv``,
+you can use ``pyenv virtualenv 3.8.6 airflow-breeze`` to create virtualenv
called ``airflow-breeze``
+with Python 3.8.6. Then you can use ``pyenv activate airflow-breeze`` to
activate it and install breeze
+in editable mode with ``pip install -e ./dev/breeze``.
+
+For ``pipx`` virtualenv, you can use the virtualenv that ``pipx`` created for
you. You can find the name
+where ``pipx`` keeps their venvs via ``pipx list`` command. Usually it is
+``${HOME}/.local/pipx/venvs/apache-airflow-breeze`` where ``$HOME`` is your
home directory.
+
+The venv can be used for running breeze tests and for debugging breeze. While
running tests should
+be usually "out-of-the-box" for most IDEs, once you configure ``./dev/breeze``
project to use the venv,
+Running/debugging a particular breeze command you want to debug might be a bit
more tricky.
+
+When you configure your "Run/Debug configuration" to run breeze command you
should
+make sure of those things:
Review Comment:
Nit: ensure truth of the points below
--
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-unsubscr...@airflow.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
