codespell-project/codespell
1
0
Fork 0
mirror of https://github.com/codespell-project/codespell.git synced 2025-05-17 15:36:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

Document required setuptools version (#2560)

Browse Source 
Building from source requires recent versions of some packages:
* setuptools>=64
* setuptools_scm[tomli]>=6.2
This commit is contained in:
Dimitri Papadopoulos Orfanos
2022-10-26 17:07:44 +02:00
committed by GitHub
parent df00783d8f
commit b00b33ecb2
2 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.rst
View File

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