Fix missing toml extra w/ setuptools-scm (GH-2475)

Project packaging is using TOML due to pyproject.toml but fails to
mention it, causing installation failures with newer setuptools-scm 6.3.0.

Commit history before merge:

* Fix missing toml extra

Fixed breakage uncovered by setuptools-scm 6.3.0 where installation
would fail for project that missed to mention the toml extra.

* Bump setuptools[-scm] to avoid toml extra

https://github.com/psf/black/pull/2475#issuecomment-912730714

> If you constraint greater than 6.3.0 and setuptools greater than 45
> you can skip the extra,

* Actually for safety reasons, just use the extra

Co-authored-by: Richard Si <63936253+ichard26@users.noreply.github.com>

diff --git a/CHANGES.md b/CHANGES.md
index ef0a57d61421fd6030a5948deb4c2ef09d20e226..4b5a291c7b95d4592800c9293f0a30a154703483 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -5,6 +5,7 @@
 ### Packaging
 
 - Fix missing modules in self-contained binaries (#2466)
+- Fix missing toml extra used during installation (#2475)
 
 ## 21.8b0
 

diff --git a/pyproject.toml b/pyproject.toml
index 30e6297447555359dddb58d038fd8a0ccf30493b..73e19608108d5541a4d1e49081b1ef2e9207b829 100644 (file)
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -23,10 +23,7 @@ extend-exclude = '''
 # NOTE: You don't need this in your own Black configuration.
 
 [build-system]
-# We're pinning setuptools-scm to bugfix versions only because for build-time
-# deps having them work on install by default is really important. Especially
-# since it's hard for users to work-around the specified build requirements.
-requires = ["setuptools>=41.0", "setuptools_scm~=6.0.1", "wheel"]
+requires = ["setuptools>=45.0", "setuptools_scm[toml]>=6.3.1", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [tool.pytest.ini_options]

diff --git a/setup.cfg b/setup.cfg
index dbd667e8f19fc6409844428a896270f763a48f65..1a0a217eb9143068e2947fdfb407ff23d233e5d3 100644 (file)
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,3 +1,3 @@
 [options]
 setup_requires =
-  setuptools_scm~=6.0.1
+  setuptools_scm[toml]>=6.3.1