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.

Sign up for GitHub

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
Merged

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

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0bfd41d
Add information to update developer environment to the developer docs
keyabarve Apr 2, 2021
95b255d
Merge branch 'latest' into Add-info-on-updating-dev-env
ctb Apr 2, 2021
54379a6
Merge branch 'latest' into Add-info-on-updating-dev-env
ctb Apr 2, 2021
91c24fc
Merge branch 'latest' of https://github.com/dib-lab/sourmash into Add…
keyabarve Apr 2, 2021
ab9eb0f
Removed the square brackets
keyabarve Apr 2, 2021
57dd159
Merge branch 'Add-info-on-updating-dev-env' of https://github.com/dib…
keyabarve Apr 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion doc/developer.md
View file
Open in desktop
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`].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

curious about the use of square brackets here - is there a reason to go with this convention? I don't think we use it anywhere else in the code base.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I must have put it there by mistake. I'll remove it right away.


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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here.


## Running tests and checks

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