Merge pull request #318 from IFCA-Advanced-Computing/feature-update-ci

Update CI

Author: Jaime Céspedes Sisniega

.codecov.yml

@@ -32,4 +32,4 @@ ignore:
   - "*/tests/.*"
   - "setup.cfg"
   - "setup.py"
-  - "pyproject.toml"
+  - "pyproject.toml"

.coveragerc

@@ -7,4 +7,4 @@ omit =
     */setup.py
     */__init__.py
     */frouros/setup.py
-    */frouros/tests/*
+    */frouros/tests/*

.github/PULL_REQUEST_TEMPLATE.md

@@ -18,4 +18,4 @@ is merged. See https://github.com/blog/1506-closing-issues-via-pull-requests
 #### Any other comments?
 
 
-<!--Thanks for contributing!-->
+<!--Thanks for contributing!-->

.github/workflows/ci.yml

@@ -6,14 +6,21 @@ on:
       - "*"
 
 jobs:
-  python-version:
-    runs-on: ubuntu-22.04
+  version:
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: ['3.9',
-                         '3.10',
-                         '3.11',
-                         '3.12',]
+        os: [
+          ubuntu-22.04,
+          windows-2022,
+          macos-12,
+        ]
+        python-version: [
+          '3.9',
+          '3.10',
+          '3.11',
+          '3.12',
+        ]
 
     steps:
       - name: Checkout
@@ -29,11 +36,22 @@ jobs:
           python -m pip install --upgrade pip
           python -m pip install setuptools==68.2.2 tox==4.12.0 tox-gh-actions==3.2.0
 
-      - name: Optional - Install frouros (only used by linters)
-        if: matrix.python-version == 3.9
+      - name: Create virtual environment
         run: |
           python -m venv .venv
+
+      - name: Activate virtual environment (Windows)
+        if: matrix.os == 'windows-2022'
+        run: |
+          .venv\Scripts\activate
+
+      - name: Activate virtual environment (Linux/macOS)
+        if: matrix.os != 'windows-2022'
+        run: |
           source .venv/bin/activate
+
+      - name: Install frouros
+        run: |
           pip install "pytest>=7.4.4,<7.5"
           pip install -e .
 

.github/workflows/documentation.yml

@@ -17,4 +17,4 @@ jobs:
     steps:
       - uses: readthedocs/actions/preview@v1
         with:
-          project-slug: "frouros"
+          project-slug: "frouros"

.gitignore

@@ -139,4 +139,4 @@ docs/source/api_reference/*/auto_generated/
 docs/source/api_reference/*/*/auto_generated/
 
 # Tests
-test-result.xml
+test-result.xml

.pre-commit-config.yaml

@@ -0,0 +1,46 @@
+default_language_version:
+    python: python3.9
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-docstring-first
+      - id: check-merge-conflict
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: no-commit-to-branch
+        args: ["--branch", "main"]
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.4
+    hooks:
+      - id: ruff
+        types_or: [
+          python,
+          pyi,
+          jupyter,
+        ]
+        args: [--fix]
+      - id: ruff-format
+        types_or: [
+          python,
+          pyi,
+          jupyter,
+        ]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.9.0
+    hooks:
+      - id: mypy
+        args: [
+          --strict,
+          --ignore-missing-imports,
+          --disable-error-code=misc,
+          --disable-error-code=no-any-return,
+        ]
+        additional_dependencies: [
+          types-requests<2.32,
+          types-toml<0.11,
+          types-tqdm<4.67,
+        ]

CITATION.cff

@@ -15,4 +15,4 @@ preferred-citation:
     orcid: "https://orcid.org/0000-0002-0013-4602"
   journal: "arXiv preprint arXiv:2208.06868"
   title: "Frouros: A Python library for drift detection in machine learning systems"
-  year: 2022
+  year: 2022

CODEOWNERS

@@ -1,3 +1,3 @@
 # CODEOWNERS file
 
-* @jaime-cespedes-sisniega
+* @jaime-cespedes-sisniega

CONTRIBUTING.md

@@ -20,11 +20,16 @@ Recommended steps for first time contributors:
     git pull
     pip install -e .
    ```
-4. After adding and committing your fix or feature, ensure that code coverage is at least 90% (otherwise the PR will be rejected) and that linting is successfully executed using the following command:
+4. (Optional but recommended) Install pre-commit hooks:
+    ```bash
+    pip install pre-commit
+    pre-commit install
+    ```
+5. After adding and committing your fix or feature, ensure that code coverage is at least 90% (otherwise the PR will be rejected) and that linting is successfully executed using the following command:
     ```bash
    tox
    ```
-5. Create pull request to the original repository.
+6. Create a pull request to the original repository.
 
 ## Reporting a bug