Convert from setup.cfg to pyproject.toml (#467)

* Convert setup.cfg to pyproject.toml

* Update workflow tools for transition to pyproject

* Note pyproject.toml conversion in changelog

Author: sirosen

.github/workflows/build.yaml

@@ -28,7 +28,7 @@ jobs:
           cache: "pip"
           cache-dependency-path: |
             .github/workflows/build.yaml
-            setup.cfg
+            pyproject.toml
             tox.ini
             cachedate.txt
 
@@ -49,12 +49,12 @@ jobs:
       - name: build and unpack sdist
         run: |
           python -m build --sdist
-          version="$(grep '^version' setup.cfg |  cut -d '=' -f2 | tr -d ' ')"
+          version="$(grep '^version' pyproject.toml | head -n1 | cut -d'"' -f2)"
           cd dist
           tar -xzf "check_jsonschema-${version}.tar.gz"
       - name: test
         run: |
-          version="$(grep '^version' setup.cfg |  cut -d '=' -f2 | tr -d ' ')"
+          version="$(grep '^version' pyproject.toml | head -n1 | cut -d'"' -f2)"
           cd "dist/check_jsonschema-${version}"
           python -m tox run -m ci
 
@@ -79,7 +79,7 @@ jobs:
           cache: "pip"
           cache-dependency-path: |
             .github/workflows/build.yaml
-            setup.cfg
+            pyproject.toml
             tox.ini
             cachedate.txt
 
@@ -93,7 +93,7 @@ jobs:
             tox
             os=${{ runner.os }}
             python=${{ steps.setup-python.outputs.python-version }}
-            hash=${{ hashFiles('.github/workflows/build.yaml', 'setup.cfg', 'tox.ini', 'cachedate.txt') }}
+            hash=${{ hashFiles('.github/workflows/build.yaml', 'pyproject.toml', 'tox.ini', 'cachedate.txt') }}
 
       - name: test
         run: |
@@ -141,7 +141,7 @@ jobs:
           cache: "pip"
           cache-dependency-path: |
             .github/workflows/build.yaml
-            setup.cfg
+            pyproject.toml
             tox.ini
             cachedate.txt
 
@@ -169,7 +169,7 @@ jobs:
           cache: "pip"
           cache-dependency-path: |
             .github/workflows/build.yaml
-            setup.cfg
+            pyproject.toml
             tox.ini
             cachedate.txt
 

.pre-commit-config.yaml

@@ -26,7 +26,6 @@ repos:
   rev: 7.1.0
   hooks:
     - id: flake8
-      args: ['--config', '.flake8']
       additional_dependencies:
         - 'flake8-bugbear==24.4.26'
         - 'flake8-typing-as-t==0.0.3'

CHANGELOG.rst

@@ -9,6 +9,7 @@ Unreleased
 ----------
 
 .. vendor-insert-here
+- Convert from ``setup.cfg`` to ``pyproject.toml`` for python package metadata
 
 - Update vendored schemas (2024-07-28)
 

Makefile

@@ -1,4 +1,4 @@
-PKG_VERSION=$(shell grep '^version' setup.cfg | cut -d '=' -f2 | tr -d ' ')
+PKG_VERSION=$(shell grep '^version' pyproject.toml | head -n1 | cut -d '"' -f2)
 
 .PHONY: lint test vendor-schemas generate-hooks release showvars
 lint:

pyproject.toml

@@ -0,0 +1,75 @@
+[build-system]
+requires = ["setuptools>=61.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "check-jsonschema"
+version = "0.29.1"
+description = "A jsonschema CLI and pre-commit hook"
+authors = [
+    { name = "Stephen Rosen", email = "[email protected]" },
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+]
+requires-python = ">=3.8"
+dependencies = [
+    'importlib-resources>=1.4.0;python_version<"3.9"',
+    'tomli>=2.0;python_version<"3.11"',
+    "ruamel.yaml==0.18.6",
+    "jsonschema>=4.18.0,<5.0",
+    "regress>=0.4.0",
+    "requests<3.0",
+    "click>=8,<9",
+]
+
+[project.readme]
+file = "README.md"
+content-type = "text/markdown"
+
+[project.urls]
+Homepage = "https://github.com/python-jsonschema/check-jsonschema"
+
+[project.optional-dependencies]
+dev = [
+    "pytest<9",
+    'click-type-test==0.0.7;python_version>="3.10"',
+    "coverage<8",
+    "pytest-xdist<4",
+    "responses==0.25.3",
+]
+docs = [
+    "sphinx<8",
+    "sphinx-issues<5",
+    "furo==2024.7.18",
+]
+
+[project.scripts]
+check-jsonschema = "check_jsonschema:main"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+namespaces = false
+
+[tool.isort]
+profile = "black"
+
+[tool.mypy]
+# strict = true  # TODO: enable
+disallow_untyped_defs = true
+ignore_missing_imports = true
+warn_unreachable = true
+warn_no_return = true
+
+[tool.pytest.ini_options]
+filterwarnings = [
+    "error",
+    # dateutil has a Python 3.12 compatibility issue.
+    'ignore:datetime\.datetime\.utcfromtimestamp\(\) is deprecated:DeprecationWarning',
+]

scripts/bump-version.py

@@ -4,19 +4,19 @@
 
 
 def get_old_version():
-    with open("setup.cfg") as fp:
+    with open("pyproject.toml") as fp:
         content = fp.read()
-    match = re.search(r"^version = (\d+\.\d+\.\d+)$", content, flags=re.MULTILINE)
+    match = re.search(r'^version = "(\d+\.\d+\.\d+)"$', content, flags=re.MULTILINE)
     assert match
     return match.group(1)
 
 
-def replace_version(filename, prefix, old_version, new_version):
+def replace_version(filename, formatstr, old_version, new_version):
     print(f"updating {filename}")
     with open(filename) as fp:
         content = fp.read()
-    old_str = prefix + old_version
-    new_str = prefix + new_version
+    old_str = formatstr.format(old_version)
+    new_str = formatstr.format(new_version)
     content = content.replace(old_str, new_str)
     with open(filename, "w") as fp:
         fp.write(content)
@@ -68,10 +68,10 @@ def main():
     print(f"old = {old_version}, new = {new_version}")
     comparse_versions(old_version, new_version)
 
-    replace_version("setup.cfg", "version = ", old_version, new_version)
-    replace_version("README.md", "rev: ", old_version, new_version)
-    replace_version("docs/precommit_usage.rst", "rev: ", old_version, new_version)
-    replace_version("docs/optional_parsers.rst", "rev: ", old_version, new_version)
+    replace_version("pyproject.toml", 'version = "{}"', old_version, new_version)
+    replace_version("README.md", "rev: {}", old_version, new_version)
+    replace_version("docs/precommit_usage.rst", "rev: {}", old_version, new_version)
+    replace_version("docs/optional_parsers.rst", "rev: {}", old_version, new_version)
     update_changelog(new_version)
 
 

scripts/set-dev-version.py

@@ -4,21 +4,21 @@
 
 
 def get_old_version():
-    with open("setup.cfg") as fp:
+    with open("pyproject.toml") as fp:
         content = fp.read()
-    match = re.search(r"^version = (\d+\.\d+\.\d+)$", content, flags=re.MULTILINE)
+    match = re.search(r'^version = "(\d+\.\d+\.\d+)"$', content, flags=re.MULTILINE)
     assert match
     return match.group(1)
 
 
-def replace_version(old_version, new_version):
-    print(f"updating setup.cfg version to {new_version}")
-    with open("setup.cfg") as fp:
+def replace_version(filename, formatstr, old_version, new_version):
+    print(f"updating {filename}")
+    with open(filename) as fp:
         content = fp.read()
-    old_str = f"version = {old_version}"
-    new_str = f"version = {new_version}"
+    old_str = formatstr.format(old_version)
+    new_str = formatstr.format(new_version)
     content = content.replace(old_str, new_str)
-    with open("setup.cfg", "w") as fp:
+    with open(filename, "w") as fp:
         fp.write(content)
 
 
@@ -32,7 +32,7 @@ def main():
     old_version = get_old_version()
     new_version = old_version + f".dev{args.number}"
 
-    replace_version(old_version, new_version)
+    replace_version("pyproject.toml", 'version = "{}"', old_version, new_version)
     print("done")