Merge pull request #48 from ricardogsilva/41-migrate-to-uv

Migrated to uv

Author: ricardogsilva

.github/workflows/ci.yaml

@@ -12,26 +12,29 @@ jobs:
   run-ci:
     runs-on: ubuntu-24.04
     steps:
-      - name: grab code
+      - name: "Grab code"
         uses: actions/checkout@v4.2.2
 
-      - name: install poetry
-        run: pipx install poetry==2.1.1
+      - name: "Install uv"
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.6.13"
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
 
-      - name: setup Python
-        uses: actions/setup-python@v5.5.0
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
-          cache: poetry
+          python-version-file: "pyproject.toml"
 
-      - name: install code with dev dependencies
-        run: poetry install --with ci --with test
+      - name: "Install code"
+        run: uv sync --frozen
 
-      - name: run ruff linter
-        run: poetry run ruff check
+      - name: "Run ruff linter"
+        run: uv run ruff check
 
-      - name: run ruff formatter
-        run: poetry run ruff format --check
+      - name: "Run ruff formatter"
+        run: uv run ruff format --check
 
-      - name: run tests
-        run: poetry run pytest
+      - name: "Run tests"
+        run: uv run pytest

.github/workflows/docs.yaml

@@ -17,25 +17,28 @@ jobs:
   build-docs:
     runs-on: ubuntu-24.04
     steps:
-      - name: grab code
+      - name: "Grab code"
         uses: actions/checkout@v4.2.2
 
-      - name: install poetry
-        run: pipx install poetry==2.1.1
+      - name: "Install uv"
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.6.13"
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
 
-      - name: setup Python
-        uses: actions/setup-python@v5.5.0
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
-          cache: poetry
+          python-version-file: "pyproject.toml"
 
-      - name: install code with dev dependencies
-        run: poetry install --with docs
+      - name: "Install code"
+        run: uv sync --frozen
 
-      - name: build docs
-        run: poetry run mkdocs build --site-dir built-docs
+      - name: "Build docs"
+        run: uv run mkdocs build --site-dir built-docs
 
-      - name: upload docs as artifacts
+      - name: "Upload docs as artifacts"
         uses: actions/upload-pages-artifact@v3.0.1
         with:
           path: built-docs/

README.md

@@ -169,7 +169,7 @@ jobs:
 
 This action's code can also be installed locally:
 
-- Install [poetry](https://python-poetry.org/docs/)
+- Install [uv](https://docs.astral.sh/uv/)
 - Clone this repository:
 
   ```shell
@@ -179,7 +179,7 @@ This action's code can also be installed locally:
 
   ```shell
   cd cite-runner
-  poetry install
+  uv sync
   ```
 
 - Start your service to be tested. Let's assume it is already running on `http://localhost:5000`
@@ -197,7 +197,7 @@ This action's code can also be installed locally:
 - Run the action code with
 
   ```shell
-  poetry run cite-runner --help
+  uv run cite-runner --help
   ```
 
 There are additional commands and options which can be used when running locally, which allow controlling the output
@@ -265,18 +265,18 @@ format and how the inputs are supplied. Read the online documentation for more d
 After having clone this repository, install the code with dev dependencies by running:
 
 ```shell
-poetry install --with dev
+uv sync
 ```
 
 Enable the pre-commit hooks by running:
 
 ```shell
-poetry run pre-commit install
+uv run pre-commit install
 ```
 
 Optionally, do a first run of pre-commit on all files, which will also initialize
 pre-commit's hooks:
 
 ```shell
-poetry run pre-commit run --all-files
+uv run pre-commit run --all-files
 ```

action.yml

@@ -56,24 +56,21 @@ runs:
     - name: 'Add action path to the global path'
       shell: bash
       run: echo "${{ github.action_path }}" >> ${GITHUB_PATH}
+    - name: 'Install uv'
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: "0.6.13"
+        enable-cache: true
+        cache-dependency-glob: "uv.lock"
     - name: 'Set up Python'
       uses: actions/setup-python@v5
       with:
-        python-version: '3.10'
-    - name: 'Set up poetry'
-      uses: Gr1N/setup-poetry@v9
-      with:
-        poetry-version: '1.8.3'
-    - name: 'Set up cache'
-      uses: actions/cache@v4
-      with:
-        path: ~/.cache/pypoetry/virtualenvs
-        key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
+        python-version-file: "pyproject.toml"
     - name: 'install action code'
       shell: 'bash'
       run: |
         cd ${{ github.action_path }}
-        poetry install
+        uv sync --frozen
     - name: 'Start TEAM engine container'
       if: ${{ !inputs.teamengine_url }}
       shell: 'bash'
@@ -90,7 +87,7 @@ runs:
       run: |
         cd ${{ github.action_path }}
         raw_result_output_path=raw-result.xml
-        poetry run cite-runner \
+        uv run cite-runner \
             --network-timeout=${{ inputs.network_timeout_seconds }} \
             execute-test-suite-from-github-actions \
             ${{ inputs.teamengine_url || 'http://localhost:8080/teamengine' }} \
@@ -106,7 +103,7 @@ runs:
       run: |
         cd ${{ github.action_path }}
         md_result_output_path=test-result.md
-        poetry run cite-runner \
+        uv run cite-runner \
             parse-result \
             --output-format=markdown \
             --include-summary \

docs/development.md

@@ -35,21 +35,20 @@ In a brief nutshell:
 
 2. Clone you fork to your local environment
 
-3. Install [poetry]
+3. Install [uv]
 
-4. Use poetry to install the cite-runner code locally, also including the
-   `dev` dependency group (and optionally also the `docs` group, if you plan
-   to work on docs):
+4. Use uv to install the cite-runner code locally. This will create a virtualenv and install all
+   dependencies needed for development, including for working on docs:
 
     ```shell
-    poetry install --with dev --with test --with docs
+    uv sync
     ```
 
 5. Optionally (but strongly recommended) enable the [pre-commit] hooks
    provided by cite-runner:
 
     ```shell
-    poetry run pre-commit install
+    uv run pre-commit install
     ```
 
 6. Stand up a docker container with a local teamengine instance:
@@ -72,19 +71,25 @@ In a brief nutshell:
 
 7. Work on the cite-runner code
 
+8. You can run cite-runner via uv with:
+
+    ```shell
+    uv run cite-runner
+    ```
+
 8. If you want to work on documentation, you can start the mkdocs server with:
 
     ```shell
-    poetry run mkdocs serve
+    uv run mkdocs serve
     ```
 
 
 [httpx]: https://www.python-httpx.org/
 [jinja]: https://jinja.palletsprojects.com/en/stable/
 [lxml]: https://lxml.de/
 [mkdocs]: https://www.mkdocs.org/
-[poetry]: https://python-poetry.org/
 [pre-commit]: https://pre-commit.com/
 [pydantic]: https://docs.pydantic.dev/latest/
 [teamengine's web API]: https://opengeospatial.github.io/teamengine/users.html
 [typer]: https://typer.tiangolo.com/
+[uv]: https://docs.astral.sh/uv/

docs/running-as-standalone-cli.md

@@ -15,25 +15,25 @@ hide:
 
     !!! warning
 
-        This also means that for the moment, cite-runner needs to be run through poetry, by means of using
-        `poetry run cite-runner`. As such, please remember to prefix all examples provided below with
-        `poetry run`.
+        This also means that for the moment, cite-runner needs to be run through uv, by means of using
+        `uv run cite-runner`. As such, please remember to prefix all examples provided below with
+        `uv run`.
 
 
-In order to use cite-runner locally you will need to have [git] and [poetry]
+In order to use cite-runner locally you will need to have [git] and [uv]
 installed. Once these are installed, cite-runner can be installed by cloning
-this repository and using poetry to install it:
+this repository and using uv to install it:
 
 ```shell
 git clone https://github.com/OSGeo/cite-runner.git
 cd cite-runner
-poetry install
+uv sync
 ```
 
 You can verify the installation by running
 
 ```shell
-poetry run cite-runner --help
+uv run cite-runner --help
 ```
 
 
@@ -249,7 +249,7 @@ before the command.
 
 [docker image]: https://hub.docker.com/r/ogccite/teamengine-production
 [git]: https://git-scm.com/
-[poetry]: https://python-poetry.org/
 [pygeoapi demo service]: https://demo.pygeoapi.io/stable
 [OGC TEAM Engine]: https://opengeospatial.github.io/teamengine/
 [teamengine EARL output format]: https://opengeospatial.github.io/teamengine/users.html#EARL_.28RDF.2FXML.29
+[uv]: https://docs.astral.sh/uv/