Skip to content

Commit

Permalink
Add direnv hint
Browse files Browse the repository at this point in the history
  • Loading branch information
hynek committed Jun 2, 2023
1 parent 6b98dfc commit 242a50a
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,15 @@ Please report any harm to [Hynek Schlawack] in any way you find appropriate.

You can (and should) run our test suite using [*tox*].
However, you’ll probably want a more traditional environment as well.
We highly recommend to develop using the version specified in the `.python-version` file in the project root.
That's the version used in CI by default.

First create a [virtual environment](https://virtualenv.pypa.io/) so you don't break your system-wide Python installation.
It’s out of scope for this document to list all the ways to manage virtual environments in Python, but if you don’t already have a pet way, take some time to look at tools like [*direnv*](https://hynek.me/til/python-project-local-venvs/), [*virtualfish*](https://virtualfish.readthedocs.io/), and [*virtualenvwrapper*](https://virtualenvwrapper.readthedocs.io/).
First, create a [virtual environment](https://virtualenv.pypa.io/) so you don't break your system-wide Python installation.
We recommend using the Python version from the `.python-version` file in project's root directory.

If you're using [*direnv*](https://direnv.net), you can automate the creation of a virtual environment with the correct Python version by adding the following `.envrc` to the project root:

```bash
layout python python$(cat .python-version)
```

Next, get an up-to-date checkout of the *argon2-cffi* repository:

Expand Down

0 comments on commit 242a50a

Please sign in to comment.