diff --git a/README.rst b/README.rst index 8ad961d800b..7f7d46bcae8 100644 --- a/README.rst +++ b/README.rst @@ -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]" @@ -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 --------------------- diff --git a/pyproject.toml b/pyproject.toml index 431834f0bc8..469c1e6d293 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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]