feat/CI (#1)

* feat: create CI

* fix: add push trigger

* refactor: rename jobs, add dummy script

* fix: run nbdev_prepare

* fix: add ruff exclude

* style: add empty line at the end

.github/workflows/deploy.yaml → .github/workflows/ghp-deploy.yaml

@@ -9,6 +9,6 @@ on:
     branches: [ "main", "master" ]
   workflow_dispatch:
 jobs:
-  deploy:
+ ghp-deploy:
     runs-on: ubuntu-latest
     steps: [uses: fastai/workflows/quarto-ghp@master]

.github/workflows/test.yaml → .github/workflows/nbdev-test.yaml

@@ -1,7 +1,7 @@
-name: CI
+name: nbdev-test
 on:  [workflow_dispatch, pull_request, push]
 
 jobs:
-  test:
+  nbdev-test:
     runs-on: ubuntu-latest
     steps: [uses: fastai/workflows/nbdev-ci@master]

.github/workflows/python.yaml

@@ -0,0 +1,39 @@
+name: python-check
+on: [ pull_request, push ]
+
+jobs:
+  python-check:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ 3.11 ]
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install deps
+        run: make install
+      - name: Check
+        run: make check
+
+  python-test:
+    needs:
+      - python-check
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ 3.11 ]
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install deps
+        run: make install
+      - name: Check
+        run: make test

Makefile

@@ -0,0 +1,21 @@
+lint_dirs := juddges scripts notebooks dashboards tests
+mypy_dirs := juddges scripts dashboards tests
+
+fix:
+	ruff check $(lint_dirs) --fix
+	ruff format $(lint_dirs)
+
+check:
+	ruff check $(lint_dirs)
+	ruff format $(lint_dirs) --check
+	mypy --install-types --non-interactive $(mypy_dirs)
+
+test:
+	coverage run -m pytest
+	coverage report -mi
+
+all: check test
+
+install:
+	pip install -r requirements.txt
+

dashboards/app.py

@@ -0,0 +1,3 @@
+import streamlit as st
+
+st.title("JuDDGES Dashboard")

docker-compose.yml

@@ -4,7 +4,7 @@ name: juddges
 services:
   web:
     build: .
-    command: streamlit run /app/juddges/dashboards/app.py
+    command: streamlit run /app/dashboards/app.py
     volumes:
       - ./:/app
       - ~/.cache:/root/.cache

pyproject.toml

@@ -0,0 +1,9 @@
+[tool.ruff]
+line-length = 100
+extend-include = ["*.ipynb"]
+exclude = ["_modidx.py"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+plugins = "numpy.typing.mypy_plugin"

requirements.txt

@@ -1,2 +1,6 @@
 nbdev==2.3.13
-streamlit==1.31.1
+streamlit==1.31.1
+ruff==0.2.2
+coverage==7.4.3
+pytest==8.0.2
+mypy==1.8.0

scripts/run_dummy.py

@@ -0,0 +1,2 @@
+# mypy requires .py file in the directory
+# file should be deleted later

tests/test_judgges.py

@@ -0,0 +1,5 @@
+from juddges import __version__
+
+
+def test_version() -> None:
+    assert __version__ == "0.0.1"