Move from legacy setup.py to pyproject.toml with flit

This change simplifies the build logic on the new packaging metadata
format provided with `pyproject.toml` using the flit build backend. The
setuptools build backend wasn't featureful enough to be usable.

This still doesn't fix the fact that installing `deepdiff` results in a
broken `deep` CLI command, but it at least pushes the ball towards a
world where that will be possible, someday.

Signed-off-by: Enji Cooper <[email protected]>

Author: ngie-eign

setup.cfg renamed to .bumpversion.cfg

@@ -4,14 +4,7 @@ commit = True
 tag = True
 tag_name = {new_version}
 
-[flake8]
-max-line-length = 120
-builtins = json
-statistics = true
-ignore = E202
-exclude = ./data,./src,.svn,CVS,.bzr,.hg,.git,__pycache__
-
-[bumpversion:file:setup.py]
+[bumpversion:file:pyproject.toml]
 
 [bumpversion:file:README.md]
 

.github/workflows/main.yaml

@@ -27,50 +27,36 @@ jobs:
       with:
         # This path is specific to Ubuntu
         path: ~/.cache/pip
-        # Look to see if there is a cache hit for the corresponding requirements file
-        key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}-${{ hashFiles('requirements-dev3.8.txt') }}
         restore-keys: |
-          ${{ runner.os }}-pip-
           ${{ runner.os }}-
     - name: Cache pip
       if: matrix.python-version != 3.8
       env:
         PYO3_USE_ABI3_FORWARD_COMPATIBILITY: "1"
       uses: actions/cache@v4
       with:
-        # This path is specific to Ubuntu
-        path: ~/.cache/pip
-        # Look to see if there is a cache hit for the corresponding requirements file
-        key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}-${{ hashFiles('requirements-dev.txt') }}
         restore-keys: |
-          ${{ runner.os }}-pip-
           ${{ runner.os }}-
     - name: Upgrade setuptools
       if: matrix.python-version >= 3.12
       run: |
         # workaround for 3.12, SEE: https://github.com/pypa/setuptools/issues/3661#issuecomment-1813845177
         pip install --upgrade setuptools
-    - name: Install dependencies
-      if: matrix.python-version > 3.9
-      run: pip install -r requirements-dev.txt
-    - name: Install dependencies
-      if: matrix.python-version <= 3.9
-      run: pip install -r requirements-dev3.8.txt
     - name: Lint with flake8
       if: matrix.python-version == 3.12
       run: |
         # stop the build if there are Python syntax errors or undefined names
-        flake8 deepdiff --count --select=E9,F63,F7,F82 --show-source --statistics
+        tox -e flake8 -- deepdiff --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 deepdiff --count --exit-zero --max-complexity=26 --max-line-lengt=250 --statistics
+        tox -e flake8 -- deepdiff --count --exit-zero --max-complexity=26 --max-line-lengt=250 --statistics
     - name: Test with pytest and get the coverage
       if: matrix.python-version == 3.12
       run: |
-        pytest --benchmark-disable --cov-report=xml --cov=deepdiff tests/ --runslow
+        tox -s -- --benchmark-disable --cov-report=xml --cov=deepdiff tests/ --runslow
     - name: Test with pytest and no coverage report
       if: matrix.python-version != 3.12
       run: |
-        pytest --benchmark-disable
+        tox -s -- --benchmark-disable tests/
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v4
       if: matrix.python-version == 3.12

pyproject.toml

@@ -0,0 +1,147 @@
+[build-system]
+requires = ["flit_core >=3.11,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "deepdiff"
+version = "8.4.2"
+dependencies = [
+  "orderly-set>=5.3.0,<6",
+]
+requires-python = ">=3.9"
+authors = [
+  { name = "Seperman", email = "[email protected]" }
+]
+maintainers = [
+  { name = "Seperman", email = "[email protected]" }
+]
+description = "Deep Difference and Search of any Python object/data. Recreate objects by adding adding deltas to each other."
+readme = "README.md"
+license = {file = "LICENSE"}
+keywords = []
+classifiers = [
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Topic :: Software Development",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: Implementation :: PyPy",
+  "Development Status :: 5 - Production/Stable",
+  "License :: OSI Approved :: MIT License"
+]
+
+# `dependency-groups` would make this a lot cleaner, in theory.
+[project.optional-dependencies]
+coverage = [
+  "coverage~=7.6.0"
+]
+cli = [
+  "click~=8.1.0",
+  "pyyaml~=6.0.0"
+]
+dev = [
+  "bump2version~=1.0.0",
+  "jsonpickle~=4.0.0",
+  "ipdb~=0.13.0",
+  "numpy~=2.2.0; python_version >= '3.10'",
+  "numpy~=2.0; python_version < '3.10'",
+  "python-dateutil~=2.9.0",
+  "orjson~=3.10.0",
+  "tomli~=2.2.0",
+  "tomli-w~=1.2.0",
+  "pandas~=2.2.0",
+  "polars~=1.21.0",
+]
+docs = [
+  # We use the html style that is not supported in Sphinx 7 anymore.
+  "Sphinx~=6.2.0",
+  "sphinx-sitemap~=2.6.0",
+  "sphinxemoji~=0.3.0"
+]
+static = [
+  "flake8~=7.1.0",
+  "flake8-pyproject~=1.2.3",
+  "pydantic~=2.10.0",
+  "types-setuptools~=75.8.0",
+]
+test = [
+  "pytest~=8.3.0",
+  "pytest-benchmark~=5.1.0",
+  "pytest-cov~=6.0.0",
+  "python-dotenv~=1.0.0",
+]
+
+[project.scripts]
+deep = "deepdiff.commands:cli"
+
+[project.urls]
+Homepage = "https://zepworks.com/deepdiff/"
+Documentation = "https://zepworks.com/deepdiff/"
+Repository = "https://github.com/seperman/deepdiff"
+Issues = "https://github.com/seperman/deepdiff/issues"
+
+[tool.coverage.run]
+branch = true
+source = ["."]
+
+[tool.flake8]
+max-line-length = 120
+builtins = "json"
+statistics = true
+ignore = "E202"
+exclude = "./data,./src,.svn,CVS,.bzr,.hg,.git,__pycache__"
+
+[tool.pytest.ini_options]
+addopts = "--pdbcls=IPython.terminal.debugger:Pdb"
+
+[tool.setuptools]
+packages = ["deepdiff"]
+
+[tool.setuptools.package-metadata]
+deepdiff = ["py.typed"]
+
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+min_version = 4.0
+env_list =
+    flake8
+    # XXX: this needs work.
+    #mypy
+    py39
+    py310
+    py311
+    py312
+    py313
+
+[testenv]
+deps =
+    .[cli]
+    .[coverage]
+    .[dev]
+    .[static]
+    .[test]
+commands =
+    python -m pytest --cov=deepdiff --cov-report term-missing {posargs:-vv tests}
+
+[testenv:flake8]
+deps =
+    .[cli]
+    .[dev]
+    .[static]
+commands =
+    python -m flake8 {posargs:deepdiff}
+
+[testenv:mypy]
+deps =
+    .[cli]
+    .[dev]
+    .[static]
+    .[test]
+    mypy
+commands =
+    python -m mypy --install-types --non-interactive {posargs:deepdiff}
+"""