Skip to content

Commit a53c275

Browse files
authored
Merge pull request #344 from NLeSC/contributing_install_deps
Remove more python3/pip3 commands from docs
2 parents b261530 + 3a1f3e5 commit a53c275

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ The sections below outline the steps in each case.
3030
1. (**important**) announce your plan to the rest of the community _before you start working_. This announcement should be in the form of a (new) issue;
3131
1. (**important**) wait until some kind of consensus is reached about your idea being a good idea;
3232
1. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest main commit. While working on your feature branch, make sure to stay up to date with the main branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions [here](https://help.github.com/articles/configuring-a-remote-for-a-fork/) and [here](https://help.github.com/articles/syncing-a-fork/));
33-
1. Install dependencies with `pip3 install -r requirements.txt`;
34-
1. make sure the existing tests still work by running ``pytest``. If project tests fails use ``pytest --keep-baked-projects`` to keep generated project in /tmp/pytest-* and investigate;
33+
1. install dependencies (see the [development documentation](README.dev.md#create-a-virtual-environment));
34+
1. make sure the existing tests still work by running ``pytest``. If project tests fail use ``pytest --keep-baked-projects`` to keep generated project files in `/tmp/pytest-*` and investigate;
3535
1. add your own tests (if necessary);
3636
1. update or expand the documentation;
3737
1. push your feature branch to (your fork of) the Python Template repository on GitHub;

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ We recommend installing `cookiecutter` in user space as per `cookiecutter`'s ins
5151
install `cookiecutter` for every new project.
5252

5353
```shell
54-
python3 -m pip install --user --upgrade cookiecutter
54+
python -m pip install --user --upgrade cookiecutter
5555
```
5656

5757
### Step 2/3: Generate the files and directory structure

{{cookiecutter.directory_name}}/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To install {{ cookiecutter.package_name }} from GitHub repository, do:
3333
```console
3434
git clone {{ cookiecutter.repository }}.git
3535
cd {{ cookiecutter.directory_name }}
36-
python3 -m pip install .
36+
python -m pip install .
3737
```
3838

3939
## Documentation

0 commit comments

Comments
 (0)