Skip to content

Commit dde654e

Browse files
Document required setuptools version
Building from source requires recent versions of some packages: * setuptools>=64 * setuptools_scm[tomli]>=6.2
1 parent df00783 commit dde654e

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

README.rst

+6
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,10 @@ applied directly, but should instead be manually inspected. E.g.:
170170
Development Setup
171171
-----------------
172172

173+
As suggested in the `Python Packaging User Guide`_, ensure pip, setuptools, and wheel are up to date before installing from source. You will specifically recent versions of setuptools and setuptools_scm::
174+
175+
pin install --upgrade pip setuptools setu1ptools_scm wheel
176+
173177
You can install required dependencies for development by running the following within a checkout of the codespell source::
174178

175179
pip install -e ".[dev]"
@@ -178,6 +182,8 @@ To run tests against the codebase run::
178182

179183
make check
180184

185+
.. _Python Packaging User Guide: https://packaging.python.org/en/latest/tutorials/installing-packages/#requirements-for-installing-packages
186+
181187
Sending Pull Requests
182188
---------------------
183189

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ homepage = "https://github.com/codespell-project/codespell"
4646
repository = "https://github.com/codespell-project/codespell"
4747

4848
[build-system]
49-
requires = ["setuptools>=45", "setuptools_scm[toml]>=6.2", "wheel"]
49+
requires = ["setuptools>=64", "setuptools_scm[toml]>=6.2", "wheel"]
5050
build-backend = "setuptools.build_meta"
5151

5252
[tool.setuptools_scm]

0 commit comments

Comments
 (0)