UV (#146)

* Convert to use uv
* Exclude jupyter notebooks from pre-commit JSON reformatting.
* Use license SPDX ID rather than name
* Update GH Actions and add caching
* Set default module name to replace '-' with '_'

Author: gsch-cmi

.github/workflows/docs.yaml

@@ -17,17 +17,20 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        enable-cache: true
+    - name: Set up Python
+      uses: actions/setup-python@v5
       with:
         python-version-file: pyproject.toml
-    - name: Install dependencies
-      run: |
-        python -m pip install poetry
-        poetry install --with docs
+    - name: Install the project
+      run: uv sync --only-group docs
     - name: Build docs
       run: |
         APP_MODULE_NAME=$(ls src -U | head -1)  # Get the first module name in the src directory
-        poetry run pdoc src/"$APP_MODULE_NAME" -o docs_build -t docs/pdoc-theme --docformat google
+        uv run pdoc src/"$APP_MODULE_NAME" -o docs_build -t docs/pdoc-theme --docformat google
         touch docs_build/.nojekyll
     - uses: JamesIves/github-pages-deploy-action@v4
       with:

.github/workflows/test.yaml

@@ -11,19 +11,20 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - name: Install poetry
-      run: pipx install poetry
-    - uses: actions/setup-python@v5
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        enable-cache: true
+    - name: Set up Python
+      uses: actions/setup-python@v5
       with:
         python-version-file: pyproject.toml
-        cache: poetry
-    - name: Install dependencies
-      run: |
-        poetry install
+    - name: Install the project
+      run: uv sync --only-dev
     - name: Run tests
       id: run-tests
       run: >
-        poetry run pytest \
+        uv run pytest \
           --junitxml=pytest.xml \
           --cov-report=term-missing:skip-covered \
           --cov-report=xml:coverage.xml \
@@ -40,30 +41,34 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - name: Install poetry
-      run: pipx install poetry
-    - uses: actions/setup-python@v5
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        enable-cache: true
+    - name: Set up Python
+      uses: actions/setup-python@v5
       with:
         python-version-file: pyproject.toml
-        cache: poetry
-    - name: Install dependencies
-      run: |
-        poetry install
+    - name: Install the project
+      run: uv sync --only-dev
     - name: Ruff format
-      run: poetry run ruff format --check
+      run: uv run ruff format --check
     - name: Ruff check
-      run: poetry run ruff check
+      run: uv run ruff check
 
   mypy:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - name: Install poetry
-      run: pipx install poetry
-    - uses: actions/setup-python@v5
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
       with:
-        python-version: '3.11'
-        cache: poetry
+        enable-cache: true
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version-file: pyproject.toml
+    - name: Install the project
+      run: uv sync --only-dev
     - run: |
-        poetry install
-        poetry run mypy .
+        uv run mypy .

.gitignore

@@ -1,3 +1,7 @@
+# MacOS system files
+.DS_Store
+
+# Ruff tmp files
 .ruff_cache
 
 # Byte-compiled / optimized / DLL files
@@ -96,12 +100,12 @@ ipython_config.py
 #   install all needed dependencies.
 #Pipfile.lock
 
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
 #   This is especially recommended for binary packages to ensure reproducibility, and is more
 #   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
+#   https://docs.astral.sh/uv/concepts/projects/layout/#the-lockfile
+#uv.lock
 
 # pdm
 #   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.

.pre-commit-config.yaml

@@ -1,11 +1,6 @@
 fail_fast: false
 
 repos:
-- repo: https://github.com/python-poetry/poetry
-  rev: 1.8.0
-  hooks:
-  - id: poetry-check
-
 - repo: https://github.com/astral-sh/ruff-pre-commit
   rev: v0.8.1
   hooks:

README.md

@@ -4,7 +4,6 @@
 
 Welcome to the CMI-DAIR Template Python Repository! This template is designed to streamline your project setup and ensure a consistent structure. To get started, follow these steps:
 
-
 - [ ] Run `setup_template.py` to initialize the repository.
 - [ ] Replace the content of this `README.md` with details specific to your project.
 - [ ] Install the `pre-commit` hooks to ensure code quality on each commit.