chore: configure uv for libraries

Author: jorgenengelsen

.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  tests:
+    uses: ./.github/workflows/test.yml
+    secrets: inherit
+
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
+      with:
+          enable-cache: true
+
+    - name: Publish package to internal package index
+      run: |
+        uv build
+        uv publish --index sevan-internal-package-index
+      env:
+        UV_PUBLISH_USERNAME: ${{ secrets.PACKAGR_USERNAME }}
+        UV_PUBLISH_PASSWORD: ${{ secrets.PACKAGR_PASSWORD }}

.github/workflows/test.yml

@@ -35,16 +35,26 @@ jobs:
 
   test:
 
-    name: Run tests
+    name: Test with ${{matrix.python-version}} on Ubuntu
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     steps:
       - uses: actions/checkout@v4
 
-      - name: Install the latest version of uv
+      - name: Install the latest version of uv and set the python version
         uses: astral-sh/setup-uv@v6
         with:
+          python-version: ${{ matrix.python-version }}
           enable-cache: true
 
-      - name: Run tests with pytest
-        run: uv run pytest
+      - name: Test with python ${{ matrix.python-version }}
+        run: uv run coverage run -m pytest tests/unit
+
+      - name: Get Test Coverage score
+        id: total
+        if: matrix.python-version == '3.12'
+        run: |
+          uv run coverage report --include=src/\* --fail-under=95 -m

.gitignore

@@ -98,7 +98,7 @@ ipython_config.py
 #   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.
-#uv.lock
+uv.lock
 
 # poetry
 #   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.

README.md

@@ -1,5 +1,5 @@
-# python-template
-A template repository for python projects in Sevan DWT.
+# python-library-template
+A template repository for python libraries made by Sevan DWT.
 
 ## Setup environment with uv
 
@@ -54,15 +54,6 @@ C:\Users\<your-username>\_netrc
 
 Your setup should now be complete.
 
-
-## Run a script
-
-To test your setup, you can try to run one of your scripts:
-
-```console
-uv run .\src\main.py
-```
-
 ## Develop your own scripts
 
 ### Add a new package

pyproject.toml

@@ -1,11 +1,16 @@
 [project]
-name = "python-template" # Change this to your package name
+name = "python-library-template" # TODO: Change this to your package name
 version = "0.1.0"
-description = "<Add your description here>"
+description = "Add your description here" # TODO: Update this description to match your library's purpose
 readme = "README.md"
+license="MIT"
+classifiers = ["Private :: Do Not Upload"] # TODO: Remove this line if you want to publish your library
 requires-python = ">=3.10, <4"
-dependencies = [
-]
+dependencies = []
+
+[build-system]
+requires = ["uv_build>=0.7.19,<0.8.0"]
+build-backend = "uv_build"
 
 [dependency-groups]
 dev = [
@@ -18,6 +23,7 @@ dev = [
 [[tool.uv.index]]
 name = "sevan-internal-package-index"
 url = "https://api.repoforge.io/EYvhW6SyL/"
+publish-url = "https://api.repoforge.io/EYvhW6SyL/"
 
 [tool.pytest.ini_options]
 pythonpath = ["src"]
@@ -40,3 +46,4 @@ select = [
 
 [tool.ruff.lint.per-file-ignores]
 "__init__.py" = ["F401"]
+

src/main.py

@@ -0,0 +1,4 @@
+# TODO Rename folder to your library name
+
+def hello_world() -> str:
+    return "Hello from python-library-template!"

src/python_library_template/__init__.py

@@ -1,4 +1,4 @@
-from main import hello_world
+from python_library_template import hello_world
 
 
 def test_hello_world():