Merge pull request #13 from iraedeus/tooling

Repository refactoring

1. Black and isort have been replaced by ruff.
2. Pylint is also replaced by ruff
3. Added mypy as a type checking tool.
4. Project management - poetry

Author: toxakaz

.github/workflows/check.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ "3.11", "3.12", "3.13" ]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install poetry
+        run: pipx install poetry
+
+      - name: Install dependencies
+        run: poetry install --with dev
+
+      - name: Ruff
+        run: poetry run ruff check
+
+      - name: Install stubs
+        run: poetry run pip install types-PyYAML types-tqdm
+
+      - name: Mypy
+        run: poetry run mypy
+
+      - name: Pytest
+        run:  poetry run python -m pytest tests

.github/workflows/code_style.yml

@@ -25,6 +25,7 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+poetry.lock
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -157,7 +158,7 @@ cython_debug/
 #  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/
+.idea/
 
 #vscode
 .vscode

.github/workflows/pylint.yml

@@ -1,7 +1,6 @@
-![PyLint](https://github.com/PySATL/MPEst/actions/workflows/pylint.yml/badge.svg)
-![Check code style](https://github.com/PySATL/MPEst/actions/workflows/code_style.yml/badge.svg)
-[![Code style](https://img.shields.io/badge/Code%20style-black-000000.svg)](https://github.com/psf/black)
-![Unit Tests](https://github.com/PySATL/MPEst/actions/workflows/test.yml/badge.svg)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+![CI](https://github.com/PySATL/pysatl-mpest/actions/workflows/check.yml/badge.svg)
+<a href="https://github.com/PySATL/pysatl-mpest/blob/main/LICENSE"><img alt="License: MIT" src="https://black.readthedocs.io/en/stable/_static/license.svg"></a>
 
 ## Installation
 
@@ -98,6 +97,6 @@ plt.show()
 ![plot](https://github.com/toxakaz/EM-algo/raw/main/examples/readme_example/example.png)
 
 ## Requirements
-- python 3.11
+- python >= 3.11
 - numpy
 - scipy

.github/workflows/test.yml

@@ -22,9 +22,7 @@
 
     counter = Clicker()
 
-    def _generate_test(
-        model: type[AModelWithGenerator], o_borders: list[tuple[float, float]]
-    ) -> list[Test]:
+    def _generate_test(model: type[AModelWithGenerator], o_borders: list[tuple[float, float]]) -> list[Test]:
         return generate_mono_test(
             model_t=model,
             params_borders=o_borders,
@@ -36,10 +34,7 @@ def _generate_test(
             tests_per_size=8,
             tests_per_cond=2,
             runs_per_test=1,
-            solvers=[
-                init_solver(16, 0.1, 0.001, 3, optimizer)
-                for optimizer in TESTS_OPTIMIZERS
-            ],
+            solvers=[init_solver(16, 0.1, 0.001, 3, optimizer) for optimizer in TESTS_OPTIMIZERS],
         )
 
     tests += _generate_test(WeibullModelExp, [(0.25, 25), (0.25, 25)])

.gitignore

@@ -7,11 +7,7 @@
 
 CPU_COUNT = os.cpu_count()
 MAX_WORKERS_PERCENT = 0.75
-MAX_WORKERS = (
-    min(round(CPU_COUNT * MAX_WORKERS_PERCENT), CPU_COUNT)
-    if CPU_COUNT is not None
-    else 1
-)
+MAX_WORKERS = min(round(CPU_COUNT * MAX_WORKERS_PERCENT), CPU_COUNT) if CPU_COUNT is not None else 1
 # MAX_WORKERS = 4
 
 RESULTS_FOLDER = EXAMPLES / "results"