Merge pull request #170 from FreddyFox892/FST/TomlUpdate

Move optional dependencies from `dev_requirements` to `pyproject.toml`
mj0nez · Oct 7, 2024 · a0fdc69 · a0fdc69
2 parents 5d347a4 + 115fc09
commit a0fdc69
Show file tree

Hide file tree

Showing 20 changed files with 52 additions and 195 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,4 @@
+.tox
+.venv
+.pytest_cache
+.mypy_cache
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -7,10 +7,6 @@ version: 2
 updates:
   - package-ecosystem: "pip" # See documentation for possible values
     directory: "/" # Location of package manifests
-    schedule:
-      interval: "daily"
-  - package-ecosystem: "pip" # See documentation for possible values
-    directory: "/dev_requirements/" # Location of package manifests
     schedule:
       interval: "weekly"
   # Maintain dependencies for GitHub Actions

diff --git a/.github/workflows/black.yml b/.github/workflows/black.yml
@@ -22,7 +22,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r dev_requirements/requirements-format.txt
+          pip install .[formatting]
       - name: ${{ matrix.tool }} Code Formatter
         run: |
           ${{ matrix.tool }} . --check
diff --git a/.github/workflows/release.yml b/.github/workflows/release.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
@@ -52,7 +56,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r dev_requirements/requirements-packaging.txt
+          pip install .[packaging]
       - name: Build wheel and source distributions
         run: |
           python -m build

diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,3 @@
+FROM python:3.8-slim-bookworm
+
+COPY . /app
diff --git a/dev_requirements/requirements-format.in b/dev_requirements/requirements-format.in
diff --git a/dev_requirements/requirements-format.txt b/dev_requirements/requirements-format.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
@@ -57,6 +57,30 @@ dependencies = [
 ]
 dynamic = ["readme", "version"]
 
+[project.optional-dependencies]
+coverage = []
+formatting = [
+    "black==24.8.0",
+    "isort==5.13.2"
+]
+linting = [
+    "pylint==3.3.1"
+]
+spell_check = [
+    "codespell==2.3.0"
+]
+packaging = [
+    "build==1.2.2",
+    "twine==5.1.1"
+]
+tests = [
+    "pytest==8.3.3"
+]
+type_check = [
+    "mypy==1.11.2",
+    "types-python-dateutil==2.9.0.20240906",
+    "types-pytz==2024.2.0.20240913"
+]
 
 [project.urls]
 Changelog = "https://github.com/mj0nez/bdew-datetimes/releases"

diff --git a/requirements.txt b/requirements.txt
@@ -1,16 +1,16 @@
 #
-# This file is autogenerated by pip-compile with Python 3.11
+# This file is autogenerated by pip-compile with Python 3.12
 # by the following command:
 #
-#    pip-compile requirements.in
+#    pip-compile --extra=test_packaging pyproject.toml
 #
-holidays==0.57
-    # via -r requirements.in
+holidays==0.57 ; python_version >= "3.8"
+    # via bdew_datetimes (pyproject.toml)
 python-dateutil==2.9.0.post0
     # via
-    #   -r requirements.in
+    #   bdew_datetimes (pyproject.toml)
     #   holidays
 pytz==2024.2
-    # via -r requirements.in
+    # via bdew_datetimes (pyproject.toml)
 six==1.16.0
     # via python-dateutil
diff --git a/tox.ini b/tox.ini
@@ -17,15 +17,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:linting]
 # the linting environment runs pylint on the code base
 deps =
     -r requirements.txt
-    -r dev_requirements/requirements-linting.txt
+    .[linting]
 setenv = PYTHONPATH = {toxinidir}/src
 commands =
     pylint bdew_datetimes
@@ -34,7 +34,7 @@ commands =
 # the type_check environment checks the type hints using mypy
 deps =
     -r requirements.txt
-    -r dev_requirements/requirements-type_check.txt
+    .[type_check]
 setenv = PYTHONPATH = {toxinidir}/src
 commands =
     mypy --show-error-codes src/bdew_datetimes
@@ -43,7 +43,7 @@ commands =
 [testenv:format]
 # install isort and black and invoke them on the current folder
 deps = 
-    -r dev_requirements/requirements-format.txt
+    .[formatting]
 commands = 
     isort .
     black .
@@ -58,12 +58,13 @@ deps =
     {[testenv:format]deps}
     pip-tools
 commands =
-    pip-compile --upgrade requirements.in
+    python -m pip install --upgrade pip
+    pip install -r requirements.txt
 
 [testenv:test_packaging]
 skip_install = true
 deps =
-    -r dev_requirements/requirements-packaging.txt
+    .[packaging]
 commands =
     python -m build
     twine check dist/*
@@ -73,7 +74,7 @@ commands =
 setenv = PYTHONPATH = {toxinidir}/src
 deps =
     -r requirements.txt
-    -r dev_requirements/requirements-spell_check.txt
+    .[spell_check]
 commands =
     codespell --ignore-words=domain-specific-terms.txt src/bdew_datetimes
     codespell --ignore-words=domain-specific-terms.txt README.md