Skip to content

Commit

Permalink
Document required setuptools version
Browse files Browse the repository at this point in the history
Building from source requires recent versions of some packages:
* setuptools>=64
* setuptools_scm[tomli]>=6.2
  • Loading branch information
DimitriPapadopoulos committed Oct 25, 2022
1 parent df00783 commit dde654e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 6 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,10 @@ applied directly, but should instead be manually inspected. E.g.:
Development Setup
-----------------

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::

pin install --upgrade pip setuptools setu1ptools_scm wheel

You can install required dependencies for development by running the following within a checkout of the codespell source::

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

make check

.. _Python Packaging User Guide: https://packaging.python.org/en/latest/tutorials/installing-packages/#requirements-for-installing-packages

Sending Pull Requests
---------------------

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ homepage = "https://github.com/codespell-project/codespell"
repository = "https://github.com/codespell-project/codespell"

[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"

[tool.setuptools_scm]
Expand Down

0 comments on commit dde654e

Please sign in to comment.