mirror of
https://github.com/codespell-project/codespell.git
synced 2025-05-17 23:46:43 +08:00
Document required setuptools version (#2560)
Building from source requires recent versions of some packages: * setuptools>=64 * setuptools_scm[tomli]>=6.2
This commit is contained in:

committed by
GitHub

parent
df00783d8f
commit
b00b33ecb2
@ -170,6 +170,10 @@ applied directly, but should instead be manually inspected. E.g.:
|
|||||||
Development Setup
|
Development Setup
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
|
As suggested in the `Python Packaging User Guide`_, ensure ``pip``, ``setuptools``, and ``wheel`` are up to date before installing from source. Specifically you will need recent versions of ``setuptools`` and ``setuptools_scm``::
|
||||||
|
|
||||||
|
pin install --upgrade pip setuptools setuptools_scm wheel
|
||||||
|
|
||||||
You can install required dependencies for development by running the following within a checkout of the codespell source::
|
You can install required dependencies for development by running the following within a checkout of the codespell source::
|
||||||
|
|
||||||
pip install -e ".[dev]"
|
pip install -e ".[dev]"
|
||||||
@ -178,6 +182,8 @@ To run tests against the codebase run::
|
|||||||
|
|
||||||
make check
|
make check
|
||||||
|
|
||||||
|
.. _Python Packaging User Guide: https://packaging.python.org/en/latest/tutorials/installing-packages/#requirements-for-installing-packages
|
||||||
|
|
||||||
Sending Pull Requests
|
Sending Pull Requests
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
|
@ -46,7 +46,7 @@ homepage = "https://github.com/codespell-project/codespell"
|
|||||||
repository = "https://github.com/codespell-project/codespell"
|
repository = "https://github.com/codespell-project/codespell"
|
||||||
|
|
||||||
[build-system]
|
[build-system]
|
||||||
requires = ["setuptools>=45", "setuptools_scm[toml]>=6.2", "wheel"]
|
requires = ["setuptools>=64", "setuptools_scm[toml]>=6.2", "wheel"]
|
||||||
build-backend = "setuptools.build_meta"
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
[tool.setuptools_scm]
|
[tool.setuptools_scm]
|
||||||
|
Reference in New Issue
Block a user