Move optional dependencies from dev_requirements to `pyproject.toml…

…`; Introduce Hatchling Build (#268) Co-authored-by: konstantin <konstantin.klein@hochfrequenz.de>
Hochfrequenz · Sep 26, 2024 · 195bb97 · 195bb97
1 parent fa5f290
commit 195bb97
Show file tree

Hide file tree

Showing 23 changed files with 127 additions and 266 deletions.
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-formatting.txt
+          pip install .[formatting]
       - name: Black Code Formatter
         run: |
           black . --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-test_packaging.txt
+           pip install .[test_packaging]
        - name: Build wheel and source distributions
          run: |
            python -m build

diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@ The framework
 - enforces users to adapt to structured and consistent patterns
 - and by doing so will lead to higher chances for maintainable and reusable code.
 
-## Architeture / Overview
+## Architecture / Overview
 The overall setup for a migration from 1-n source systems (A, B, C...) to 1-m target systems (1,2, 3...) might look like this:
 
 ```mermaid

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-test_packaging.in b/dev_requirements/requirements-test_packaging.in
diff --git a/dev_requirements/requirements-test_packaging.txt b/dev_requirements/requirements-test_packaging.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/domain-specific-terms.txt b/domain-specific-terms.txt
@@ -0,0 +1,2 @@
+# contains 1 lower case word per line which are ignored in the spell_check
+adresse
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,3 +1,70 @@
+[project]
+name = "bomf"
+description = "BO4E Migration Framework"
+license = { text = "MIT" }
+requires-python = ">=3.11"
+authors = [{ name = "Hochfrequenz Unternehmensberatung GmbH", email = "info@hochfrequenz.de" }]
+keywords = ["BO4E", "Migration", "Data"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "pydantic>=2.0.0",
+    "typeguard",
+    "frozendict",
+    "bidict",
+    "networkx",
+    "injector",
+    "python-generics",
+    "pvframework"
+]     # add all the dependencies here
+dynamic = ["readme", "version"]
+
+[project.optional-dependencies]
+tests = [
+    "pytest==8.3.3",
+    "pytest-asyncio==0.24.0",
+    "bo4e==202401.2.1"
+]
+linting = [
+    "pylint==3.2.7"
+]
+type_check = [
+    "mypy==1.11.2",
+    "networkx-stubs==0.0.1",
+    "types-frozendict==2.0.9"
+]
+spellcheck = [
+    "codespell==2.3.0"
+]
+coverage = [
+    "coverage==7.6.1"
+]
+formatting = [
+    "black==24.8.0",
+    "isort==5.13.2"
+]
+test_packaging = [
+    "build==1.2.2",
+    "twine==5.1.1"
+]
+dev = [
+    "pip-tools"
+]
+
+
+[project.urls]
+Changelog = "https://github.com/Hochfrequenz/bo4e_migration_framework/releases"
+Homepage = "https://github.com/Hochfrequenz/bo4e_migration_framework"
+
 [tool.black]
 line-length = 120
 
@@ -9,6 +76,12 @@ profile = "black"
 max-line-length = 120
 disable="fixme"
 
+[mypy]
+truethy-bool = true
+
+[tool.mypy]
+disable_error_code = []
+
 [tool.pytest.ini_options]
 # When the mode is auto, all discovered async tests are considered asyncio-driven
 # even if they have no @pytest.mark.asyncio marker.
@@ -18,7 +91,26 @@ asyncio_mode = "auto"
 # the following lines are needed if you would like to build a python package
 # and you want to use semantic versioning
 [build-system]
-requires = ["setuptools>=41.0", "wheel", "setuptools_scm[toml]>=3.4"]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling>=1.8.0", "hatch-vcs", "hatch-fancy-pypi-readme"]
+build-backend = "hatchling.build"
+
+
+[tool.hatch.metadata.hooks.fancy-pypi-readme]
+content-type = "text/markdown"
+fragments = [{ path = "README.md" }]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/_bomf_version.py"
+template = '''
+version = "{version}"
+'''
+
+[tool.hatch.build.targets.sdist]
+exclude = ["/unittests"]
 
-[tool.setuptools_scm]
+[tool.hatch.build.targets.wheel]
+only-include = ["src"]
+sources = ["src"]
diff --git a/requirements.txt b/requirements.txt
@@ -1,5 +1,5 @@
 #
-# 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
@@ -36,4 +36,3 @@ typing-extensions==4.9.0
     # via
     #   pydantic
     #   pydantic-core
-    #   typeguard