Switch packaging to pyproject.toml

Author: xylar

setup.cfg renamed to .flake8.cfg

@@ -24,33 +24,3 @@ exclude =
     .pytest_cache,
     *__init__.py,
     venv,
-
-[isort]
-multi_line_output=3
-include_trailing_comma=True
-force_grid_wrap=0
-use_parentheses=True
-line_length=88
-
-[pycodestyle]
-max-line-length = 119
-exclude =
-    .tox
-    .git
-    */migrations/*
-    */static/CACHE/*
-    docs
-    node_modules
-    .idea
-    .mypy_cache
-    .pytest_cache
-    *__init__.py
-    venv
-
-[mypy]
-python_version = 3.13
-check_untyped_defs = True
-ignore_missing_imports = True
-warn_unused_ignores = True
-warn_redundant_casts = True
-warn_unused_configs = True

.pre-commit-config.yaml

@@ -1,5 +1,4 @@
 exclude: "docs|node_modules|migrations|.git|.tox"
-default_stages: [commit]
 fail_fast: true
 
 repos:
@@ -30,15 +29,15 @@ repos:
     rev: 7.3.0
     hooks:
       - id: flake8
-        args: ["--config=setup.cfg"]
+        args: ["--config=.flake8.cfg"]
         additional_dependencies: [flake8-isort==6.1.1]
 
   # Can run individually with `pre-commit run mypy --all-files`
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.18.2
     hooks:
       - id: mypy
-        args: ["--config=setup.cfg"]
+        args: ["--config=pyproject.toml"]
 
 # https://pre-commit.ci/#configuration
 ci:

docs/source/dev_guide/release.rst

@@ -31,7 +31,7 @@ Bumping the Version
 
     ::
 
-        git fetch upstream main 
+        git fetch upstream main
         # Prepend "v" to <version>
         # For release candidates, append "rc" to <version>
         git checkout -b v<version> upstream/main
@@ -46,8 +46,8 @@ Bumping the Version
 
         :: Bumping from 1.0.0 to 1.1.0
         => Would patch these files
-        - setup.py:26 version="1.0.0",
-        + setup.py:26 version="1.1.0",
+        - pyproject.toml: version = "1.0.0"
+        + pyproject.toml: version = "1.1.0"
         - zppy/__init__.py:1 __version__ = "v1.0.0"
         + zppy/__init__.py:1 __version__ = "v1.1.0"
         - conda/meta.yaml:2 {% set version = "1.0.0" %}

pyproject.toml

@@ -2,6 +2,61 @@
 # Unforunately, black does not support setup.cfg (refer to link).
 # https://github.com/psf/black/issues/683#issuecomment-490236406
 
+[build-system]
+requires = [
+  "setuptools>=64",
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "zppy"
+version = "3.0.0"
+description = "Post-processing software for E3SM"
+readme = "README.md"
+requires-python = ">=3.11,<3.14"
+license = { file = "LICENSE" }
+authors = [
+  { name = "Ryan Forsyth", email = "[email protected]" },
+  { name = "Chris Golaz", email = "[email protected]" },
+]
+keywords = ["E3SM", "post-processing", "climate", "analysis"]
+
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: BSD License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Scientific/Engineering",
+]
+
+[project.urls]
+Homepage = "https://github.com/E3SM-Project/zppy"
+Issues = "https://github.com/E3SM-Project/zppy/issues"
+Repository = "https://github.com/E3SM-Project/zppy.git"
+
+[project.scripts]
+zppy = "zppy.__main__:main"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+include = ["zppy", "zppy.*"]
+
+[tool.setuptools.package-data]
+zppy = [
+  "**/*.bash",
+  "**/*.csh",
+  "**/*.cfg",
+  "**/*.ini",
+  "**/*.sh",
+  "**/*.json",
+]
+
 [tool.black]
 line-length = 88
 target-version = ['py311']
@@ -16,3 +71,34 @@ exclude = '''
     | docs
  )/
 '''
+
+[tool.isort]
+multi_line_output = 3
+include_trailing_comma = true
+force_grid_wrap = 0
+use_parentheses = true
+line_length = 88
+
+[tool.pycodestyle]
+max-line-length = 119
+exclude = [
+  ".tox",
+  ".git",
+  "*/migrations/*",
+  "*/static/CACHE/*",
+  "docs",
+  "node_modules",
+  ".idea",
+  ".mypy_cache",
+  ".pytest_cache",
+  "*__init__.py",
+  "venv",
+]
+
+[tool.mypy]
+python_version = "3.13"
+check_untyped_defs = true
+ignore_missing_imports = true
+warn_unused_ignores = true
+warn_redundant_casts = true
+warn_unused_configs = true

setup.py

@@ -23,7 +23,7 @@ tag_template = "v{new_version}"
 # section containing the path of the file, relative to the
 # tbump.toml location.
 [[file]]
-src = "setup.py"
+src = "pyproject.toml"
 
 [[file]]
 src = "zppy/__init__.py"