Move optional dependencies from dev_requirements to pyproject.toml (

#157) * Move optional dependencies from `dev_requirements` to `pyproject.toml` * add maus
Hochfrequenz · Sep 25, 2024 · 0d3bcd3 · 0d3bcd3
1 parent 729e53a
commit 0d3bcd3
Show file tree

Hide file tree

Showing 18 changed files with 53 additions and 226 deletions.
diff --git a/.github/workflows/formatting.yml b/.github/workflows/formatting.yml
@@ -21,7 +21,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r dev_requirements/requirements-formatting.txt
+          pip install .[formatting]
       - name: ${{ matrix.tool }} Code Formatter
         run: |
           ${{ matrix.tool }} . --check
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
@@ -35,7 +35,11 @@ jobs:
 
   build-n-publish:
     name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [ "3.12" ]
+        os: [ ubuntu-latest ]
     # Specifying a GitHub environment, # Specifying a GitHub environment, which is strongly recommended by PyPI: https://docs.pypi.org/trusted-publishers/adding-a-publisher/
     # you have to create an environment in your repository settings and add the environment name here
     environment: release
@@ -45,14 +49,14 @@ jobs:
     needs: tests
     steps:
       - uses: actions/checkout@v4
-      - name: Set up Python
+      - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r dev_requirements/requirements-packaging.txt
+          pip install .[test_packaging]
       - name: Build wheel and source distributions
         run: |
           python -m build

diff --git a/dev_requirements/requirements-coverage.in b/dev_requirements/requirements-coverage.in
diff --git a/dev_requirements/requirements-coverage.txt b/dev_requirements/requirements-coverage.txt
diff --git a/dev_requirements/requirements-formatting.in b/dev_requirements/requirements-formatting.in
diff --git a/dev_requirements/requirements-formatting.txt b/dev_requirements/requirements-formatting.txt
diff --git a/dev_requirements/requirements-linting.in b/dev_requirements/requirements-linting.in
diff --git a/dev_requirements/requirements-linting.txt b/dev_requirements/requirements-linting.txt
diff --git a/dev_requirements/requirements-packaging.in b/dev_requirements/requirements-packaging.in
diff --git a/dev_requirements/requirements-packaging.txt b/dev_requirements/requirements-packaging.txt
diff --git a/dev_requirements/requirements-spell_check.in b/dev_requirements/requirements-spell_check.in
diff --git a/dev_requirements/requirements-spell_check.txt b/dev_requirements/requirements-spell_check.txt
diff --git a/dev_requirements/requirements-tests.in b/dev_requirements/requirements-tests.in
diff --git a/dev_requirements/requirements-tests.txt b/dev_requirements/requirements-tests.txt
diff --git a/dev_requirements/requirements-type_check.in b/dev_requirements/requirements-type_check.in
diff --git a/dev_requirements/requirements-type_check.txt b/dev_requirements/requirements-type_check.txt
diff --git a/pyproject.toml b/pyproject.toml
@@ -17,11 +17,45 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
 ]
 
-dependencies = ["click", "loguru", "jinja2", "pydantic", "python-docx", "efoli>=0.0.3"] # add all the dependencies here
-
+dependencies = [
+    "click",
+    "loguru",
+    "jinja2",
+    "pydantic",
+    "python-docx",
+    "efoli>=0.0.3"
+] # add all the dependencies here
 
 dynamic = ["readme", "version"]
 
+[project.optional-dependencies]
+coverage = [
+    "coverage==7.6.1"
+]
+formatting = [
+    "black==24.8.0",
+    "isort==5.13.2"
+]
+linting = [
+    "pylint==3.3.0"
+]
+spellcheck = [
+    "codespell==2.3.0"
+]
+test_packaging = [
+    "build==1.2.2",
+    "twine==5.1.1"
+]
+tests = [
+    "maus[tree]==0.6.1",
+    "pytest==8.3.3",
+    "pytest-loguru==0.4.0",
+    "syrupy==4.7.1"
+]
+type_check = [
+    "mypy==1.11.2"
+]
+
 [project.urls]
 Changelog = "https://github.com/Hochfrequenz/migmose/releases"
 Homepage = "https://github.com/Hochfrequenz/migmose"

diff --git a/tox.ini b/tox.ini
@@ -15,15 +15,15 @@ commands = python -m pip install --upgrade pip
 # the tests environment is called by the Github action that runs the unit tests
 deps =
     -r requirements.txt
-    -r dev_requirements/requirements-tests.txt
+    .[tests]
 setenv = PYTHONPATH = {toxinidir}/src
 commands = python -m pytest --basetemp={envtmpdir} {posargs}
 
 [testenv:update_snapshots]
 # the tests environment is called by the Github action that runs the unit tests
 deps =
     -r requirements.txt
-    -r dev_requirements/requirements-tests.txt
+    .[tests]
     syrupy
 setenv = PYTHONPATH = {toxinidir}/src
 commands = python -m pytest --basetemp={envtmpdir} {posargs} --snapshot-update
@@ -32,10 +32,11 @@ commands = python -m pytest --basetemp={envtmpdir} {posargs} --snapshot-update
 # the linting environment is called by the Github Action that runs the linter
 deps =
     {[testenv:tests]deps}
-    -r dev_requirements/requirements-linting.txt
+    .[linting]
     # add your fixtures like e.g. pytest_datafiles here
 setenv = PYTHONPATH = {toxinidir}/src
 commands =
+    pylint src --ignore=_migmose_version.py
     pylint migmose
     pylint unittests --rcfile=unittests/.pylintrc
     # add single files (ending with .py) or packages here
@@ -45,7 +46,7 @@ commands =
 setenv = PYTHONPATH = {toxinidir}/src
 deps =
     {[testenv:tests]deps}
-    -r dev_requirements/requirements-type_check.txt
+    .[type_check]
 commands =
     mypy --show-error-codes src/migmose --strict
     mypy --show-error-codes unittests
@@ -56,7 +57,7 @@ commands =
 setenv = PYTHONPATH = {toxinidir}/src
 deps =
     -r requirements.txt
-    -r dev_requirements/requirements-spell_check.txt
+    .[spellcheck]
 commands =
     codespell --ignore-words=domain-specific-terms.txt src
     codespell --ignore-words=domain-specific-terms.txt README.md
@@ -66,19 +67,13 @@ commands =
 # the coverage environment is called by the Github Action that runs the coverage measurement
 deps =
     {[testenv:tests]deps}
-    -r dev_requirements/requirements-coverage.txt
+    .[coverage]
 setenv = PYTHONPATH = {toxinidir}/src
 commands =
     coverage run -m pytest --basetemp={envtmpdir} {posargs}
     coverage html --omit .tox/*,unittests/*,src/migmose/__main__.py
     coverage report --fail-under 80 --omit .tox/*,unittests/*,src/migmose/__main__.py
 
-[testenv:compile_requirements]
-deps =
-    pip-compile-multi
-commands =
-    pip-compile-multi -d dev_requirements --autoresolve
-
 [testenv:dev]
 # the dev environment contains everything you need to start developing on your local machine.
 deps =
@@ -87,7 +82,7 @@ deps =
     {[testenv:type_check]deps}
     {[testenv:coverage]deps}
     {[testenv:spell_check]deps}
-    -r dev_requirements/requirements-formatting.txt
+    .[formatting]
     pip-tools
     pre-commit
 commands =
@@ -98,7 +93,7 @@ commands =
 [testenv:test_packaging]
 skip_install = true
 deps =
-    -r dev_requirements/requirements-packaging.txt
+    .[test_packaging]
 commands =
     python -m build
     twine check dist/*