Skip to content

Commit 5a1657c

Browse files
authored
Merge pull request #933 from scop/docs/dev-python-deps
docs: Python dependency clarifications
2 parents 4f6632b + 0fcd83e commit 5a1657c

File tree

5 files changed

+13
-3
lines changed

5 files changed

+13
-3
lines changed

.github/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
-r ../test/requirements-dev.txt
22

33
gitlint==0.19.1
4+
pre-commit>=2.4.0

.pre-commit-config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
default_stages: [commit]
2+
minimum_pre_commit_version: 2.4.0
23

34
repos:
45

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,15 @@ Also, please bear the following coding guidelines in mind:
199199
- In addition to running the test suite, there are a few scripts in the test/
200200
dir that catch some common issues, see and use for example runLint.
201201

202+
- Make sure you have Python 3.7 or later installed. This is required for
203+
running the development tooling, linters etc. Rest of the development
204+
Python dependencies are specified in `test/requirements-dev.txt` which
205+
can be fed for example to `pip`:
206+
207+
```shell
208+
python3 -m pip install -r test/requirements-dev.txt
209+
```
210+
202211
- Install pre-commit and set it up, see <https://pre-commit.com/>.
203212
That'll run a bunch of linters and the like, the same as the
204213
bash-completion CI does. Running it locally and fixing found issues before

doc/testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ dependencies are specified in the `test/requirements.txt` file. If using `pip`,
2323
this file can be fed directly to it, e.g. like:
2424

2525
```shell
26-
pip install -r test/requirements.txt
26+
python3 -m pip install -r test/requirements.txt
2727
```
2828

2929
### Debian/Ubuntu

test/requirements-dev.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# Python >= 3.6.1 required here
1+
# Python >= 3.7 required here
22

33
-r requirements.txt
44

55
black==23.1.0
66
mypy==1.2.0
7-
pre-commit>=2.4.0
87
ruff==0.0.247

0 commit comments

Comments
 (0)