Migrate from poetry to uv #454
Conversation
icui
requested review from
lsawade and
Rohit-Kakodkar
and removed request for
Rohit-Kakodkar
|
gotta git checkout devel && git pull origin devel && git checkout issue-161 && git merge devel |
|
|
||
| Install SPECFEM++ development environment | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| poetry install | ||
| uv sync --extra dev |
There was a problem hiding this comment.
Do you not need the extra line for the code-block?
There was a problem hiding this comment.
I haven't run clang-format for all files yet. Maybe do it after we merge devel to main.
There was a problem hiding this comment.
if you run make html in docs, there are a lot of errors but most errors are related to formatting and tell you where the underlines are too short/long
|
|
||
| Install poetry | ||
| Install uv |
There was a problem hiding this comment.
Also the underline for headers in RST files require the exact length of the title string
| ~~~~~~~~~~~~~~~ | ||
|
|
||
| Download and install poetry using the `official instructions <https://python-poetry.org/docs/#installation>`_. | ||
| Download and install uv using the `official instructions <https://docs.astral.sh/uv/getting-started/installation>`_. | ||
|
|
||
| Install SPECFEM++ development environment | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
There was a problem hiding this comment.
here too, but that wasn't you. A lot of the docs are probs written by copilot, and copilot is not doing it right.
|
|
||
| Using your python/poetry environment | ||
| Using your python/uv environment |
|
|
||
| .. code-block:: bash | ||
|
|
||
| poetry run python <script_name>.py | ||
| source .venv/bin/activate | ||
|
|
||
| Pre-commit hooks | ||
| ~~~~~~~~~~~~~~~~~ |
| @@ -15,11 +15,11 @@ To make a change to SPECFEM++ (This development workflow is similar to the one s | |||
|
|
|||
| .. note:: | |||
|
|
|||
| It is also recommended that you run :code:`poetry install` every time you pull the develop branch. Please check :ref:`style section<style>` for more information on poetry. | |||
| It is also recommended that you run :code:`uv sync --extra dev` every time you pull the develop branch. Please check :ref:`style section<style>` for more information on uv. | |||
There was a problem hiding this comment.
The underline in this file's header is too long
| @@ -4,69 +4,59 @@ Style | |||
| Pre-commit | |||
| ---------- | |||
|
|
|||
| SPECFEM++ uses pre-commit to check style. Pre-commit can be installed inside python virtual environments. There are several methods for creating virtual environments, but I've found poetry tool is great at managing python environments. Especailly in collaborative environments poetry gives easy method for managing consistency of environments between all contributors via :code:`pyproject.toml` and :code:`poetry.lock` files. | |||
| SPECFEM++ uses pre-commit to check style. Pre-commit can be installed inside python virtual environments. There are several methods for creating virtual environments, but I've found uv tool is great at managing python environments. Especailly in collaborative environments uv gives easy method for managing consistency of environments between all contributors via :code:`pyproject.toml` and :code:`uv.lock` files. | |||
There was a problem hiding this comment.
Header here at the very top is too long.
|
|
||
| Install SPECFEM++ development environment | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| poetry install | ||
| uv sync --extra dev |
There was a problem hiding this comment.
if you run make html in docs, there are a lot of errors but most errors are related to formatting and tell you where the underlines are too short/long
Closes #161