major: Dev

.bumpversion.cfg

@@ -0,0 +1,12 @@
+[bumpversion]
+current_version = 0.6.0
+commit = True
+tag = True
+
+[bumpversion:file:pyproject.toml]
+search = version = "{current_version}"
+replace = version = "{new_version}"
+
+[bumpversion:file:score_models/__init__.py]
+search = __version__ = "{current_version}"
+replace = __version__ = "{new_version}"

.flake8

@@ -0,0 +1,5 @@
+[flake8]
+max-line-length = 127
+max-complexity = 10
+select = E9,F63,F7,F82
+ignore = TC002,TC201

.github/labeler.yml

@@ -0,0 +1,6 @@
+bugfix:
+  - "*fix*"
+feature:
+  - "*feature*"
+major:
+  - "*major*"

.github/workflows/coverage.yml

@@ -0,0 +1,64 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - '**'  # Trigger on all branches
+  pull_request:
+    branches:
+      - master
+      - dev
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+        os: [ubuntu-latest]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
+
+      - name: Record State
+        run: |
+          pwd
+          echo github.ref is: ${{ github.ref }}
+          echo GITHUB_SHA is: $GITHUB_SHA
+          echo github.event_name is: ${{ github.event_name }}
+          echo github workspace: ${{ github.workspace }}
+          pip --version
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pytest pytest-cov
+          cd $GITHUB_WORKSPACE
+          pip install -r requirements.txt
+
+      - name: Install package
+        run: |
+          pip install -e .
+
+      - name: Test
+        run: |
+          pytest --cov=${{ env.PROJECT_NAME }} --cov-report=xml --cov-report=term tests/
+        # Generate coverage report
+        continue-on-error: true  # Allow tests to fail without breaking the workflow
+
+      - name: Upload coverage reports to Codecov
+        if: matrix.python-version == '3.10'  # Change this to upload coverage only for a specific version
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella

.github/workflows/deploy_package.yml

@@ -0,0 +1,82 @@
+name: Version Bump and Deploy
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  bump-version:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: pip install bump2version
+
+      - name: Get Labels of Last Merged PR
+        id: get-labels
+        run: |
+          last_commit=$(git log -1 --pretty=format:"%H")
+          labels=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+          "https://api.github.com/repos/${{ github.repository }}/commits/$last_commit/pulls" | \
+          jq -r '.[0].labels[].name')
+          echo "Labels found: $labels"
+          echo "labels=$labels" >> $GITHUB_ENV
+
+      - name: Determine Version Bump
+        id: bump
+        run: |
+          if [[ "${{ env.labels }}" == *"bugfix"* ]]; then
+            echo "bump_type=patch" >> $GITHUB_ENV
+          elif [[ "${{ env.labels }}" == *"feature"* ]]; then
+            echo "bump_type=minor" >> $GITHUB_ENV
+          elif [[ "${{ env.labels }}" == *"major"* ]]; then
+            echo "bump_type=major" >> $GITHUB_ENV
+          else
+            echo "No valid label found for version bump."
+            exit 1
+
+      - name: Bump Version
+        if: env.bump_type != ''
+        run: bump2version ${{ env.bump_type }}
+
+      - name: Push Changes
+        if: env.bump_type != ''
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: git push --follow-tags
+
+  deploy:
+    needs: bump-version
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies for deployment
+        run: |
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: |
+          twine upload dist/*

.github/workflows/docs.yml

@@ -0,0 +1,53 @@
+name: Build and Deploy Docs
+on:
+  push:
+    branches:
+      - master
+      - dev
+      - docs
+
+permissions:
+  contents: write  # This allows the action to push to the repository
+
+jobs:
+  build-book:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+
+      - name: Install requirements
+        run: pip install -r docs_requirements.txt
+
+      - name: Build Jupyter Book
+        run: jupyter-book build docs
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: jupyter-book-html
+          path: docs/_build/html
+
+  deploy-pages:
+    runs-on: ubuntu-latest
+    needs: build-book
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Download artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: jupyter-book-html
+          path: docs/_build/html
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/_build/html

.github/workflows/label_pr.yml

@@ -0,0 +1,26 @@
+name: Auto Label PR
+
+on:
+  pull_request:
+    types: [opened, edited]
+
+jobs:
+  label:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Run Labeler
+        uses: actions/labeler@v3
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+
+      - name: Apply Labels Based on Title
+        id: label
+        run: |
+          labels=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+          "https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/labels" | \
+          jq -r '.[].name')
+          echo "labels=$labels" >> $GITHUB_ENV

.github/workflows/python-package.yml

@@ -1,6 +1,5 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
-
 name: Python package
 
 on:
@@ -12,9 +11,9 @@ on:
     branches:
       - master
       - dev
+
 jobs:
   build:
-
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -30,11 +29,11 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install flake8 pytest
+        python -m pip install flake8 pytest flake8-type-checking
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        flake8 . --count --select=E9,F63,F7,F82,TC,TC2 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics

.gitignore

@@ -153,17 +153,11 @@ dmypy.json
 cython_debug/
 
 # PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
 models/
 data/
 __pycache__/*
 .vim
-/docs/
-/doc/
 /*.html
 /*.pdf
 Makefile

.readthedocs.yaml

@@ -0,0 +1,15 @@
+version: 2
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "3.9"
+  jobs:
+    pre_build:
+      - "jupyter-book config sphinx docs/"
+
+python:
+  install:
+    - requirements: docs_requirements.txt
+    - method: pip
+      path: .