Initial commit from pymetrius template

.github/workflows/common_steps.yml

@@ -0,0 +1,44 @@
+
+# Common step definitions to be included by other workflows
+# This way we can centralize the package manager-specific steps
+
+# Poetry setup steps
+poetry-setup:
+  - name: Install poetry
+    uses: abatilo/actions-poetry@v2
+  - name: Setup a local virtual environment (if no poetry.toml file)
+    run: |
+      poetry config virtualenvs.create true --local
+      poetry config virtualenvs.in-project true --local
+  - uses: actions/cache@v3
+    name: Define a cache for the virtual environment based on the dependencies lock file
+    with:
+      path: ./.venv
+      key: venv-${{ hashFiles('poetry.lock') }}
+  - name: Install the project dependencies
+    run: |
+      poetry install --with dev
+
+# UV setup steps
+uv-setup:
+  - name: Install uv
+    run: pip install uv
+  - uses: actions/cache@v3
+    name: Cache dependencies
+    with:
+      path: ~/.cache/uv
+      key: uv-${{ hashFiles('pyproject.toml') }}
+  - name: Install dependencies
+    run: |
+      uv venv
+      uv pip install -e ".[dev]"
+
+# Pixi setup steps
+pixi-setup:
+  - name: Install pixi
+    uses: prefix-dev/setup-pixi@v0.4.1
+    with:
+      pixi-version: v0.7.0
+  - name: Install dependencies
+    run: pixi install
+ 

.github/workflows/lint_and_docs.yaml

@@ -0,0 +1,51 @@
+name: Linting, Types and Docs Check
+
+on: [push, pull_request]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      pages: write
+      actions: write
+      contents: read
+    steps:
+      - name: Cancel previous run
+        uses: styfle/cancel-workflow-action@0.11.0
+        with:
+          access_token: ${{ github.token }}
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+      
+      
+      # use uv package manager
+      - name: Install uv
+        run: pip install uv
+      - uses: actions/cache@v3
+        name: Cache dependencies
+        with:
+          path: ~/.cache/uv
+          key: uv-${{ hashFiles('pyproject.toml') }}
+      - name: Install dependencies
+        run: |
+          uv venv
+          uv pip install -e ".[dev]"
+      - name: Lint
+        run: uv run poe lint
+      - name: Types
+        run: uv run poe type-check
+      - name: Docs
+        run: uv run poe doc-build
+      
+      
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: "docs/_build"
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.github/workflows/publish.yaml

@@ -0,0 +1,27 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.11
+          
+      
+      - name: Install build and twine
+        run: pip install build twine
+      - name: Build and publish
+        env:
+          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          if [ -z "${PYPI_TOKEN}" ]; then echo "Set the PYPI_TOKEN variable in your repository secrets"; exit 1; fi
+          python -m build
+          python -m twine upload dist/* --username __token__ --password $PYPI_TOKEN
+      

.github/workflows/pytest.yml

@@ -0,0 +1,40 @@
+name: Tests on Ubuntu
+
+on: [push, pull_request]
+
+jobs:
+  cpu:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, 'ci skip')"
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+    steps:
+      - name: Cancel previous run
+        uses: styfle/cancel-workflow-action@0.11.0
+        with:
+          access_token: ${{ github.token }}
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: "${{ matrix.python-version }}"
+
+      # Include the appropriate package manager steps based on the selection
+      
+      - name: Setup and install dependencies with UV
+        uses: ./.github/workflows/common_steps.yml
+        with:
+          steps: uv-setup
+      - name: Test with pytest
+        run: uv run poe test
+      
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v1
+        with:
+          token: ${{ secrets.CODECOV }}
+          file: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: false

.github/workflows/windows_mac_test.yml

@@ -0,0 +1,39 @@
+name: Tests on Windows and MacOS
+
+on: [push, pull_request]
+
+jobs:
+  cpu-extra:
+    runs-on: ${{ matrix.os }}
+    if: "!contains(github.event.head_commit.message, 'ci skip')"
+    strategy:
+      matrix:
+        os: [macos-latest, windows-latest]
+        python-version: [3.11]
+    steps:
+      - name: Cancel previous run
+        uses: styfle/cancel-workflow-action@0.11.0
+        with:
+          access_token: ${{ github.token }}
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      
+      
+      # use uv package manager
+      - name: Install uv
+        run: pip install uv
+      - uses: actions/cache@v3
+        name: Cache dependencies
+        with:
+          path: ~/.cache/uv
+          key: uv-${{ hashFiles('pyproject.toml') }}
+      - name: Install dependencies
+        run: |
+          uv venv
+          uv pip install -e ".[dev]"
+      - name: Test with pytest
+        run: uv run poe test-subset
+