Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding information about updating developer environment to the developer docs #1432

Merged
merged 6 commits into from
Apr 3, 2021
8 changes: 7 additions & 1 deletion doc/developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,18 @@ tox -e dev
. .tox/dev/bin/activate
```

Finally, ou can also explicitly install all the Python dependencies for sourmash by running
Finally, you can also explicitly install all the Python dependencies for sourmash by running
```
pip install -r requirements.txt
```
(but they are already installed in the virtualenv created with `tox -e dev`).

## Updating your developer environment

To update rust to the latest version, use `rustup update`.

To update your Python dependencies to the latest required for sourmash, you can run `pip install -r requirements.txt`.

## Running tests and checks

We use [`tox`](https://tox.readthedocs.io) for managing dependencies and
Expand Down