Skip to content

Recommend isolated env #3190

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

Merged
benjeffery merged 1 commit into from
Jun 6, 2025
Merged

Recommend isolated env #3190

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 5 additions & 6 deletions docs/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,21 +79,20 @@ $ sudo apt install python3-dev python-is-python3 build-essential doxygen
```

Python packages required for development are listed in `python/requirements/development.txt`.
These can be installed using `pip`::
These can be installed using `pip`. We recommend using an isolated environment as below:

```bash
$ python3 -m venv env
$ source env/bin/activate
$ python3 -m pip install -r python/requirements/development.txt
```

You may wish isolate your development environment using a `virtualenv
<https://docs.python-guide.org/dev/virtualenvs/>`_.

A few extra dependencies are required if you wish to work on the
{ref}`C library <sec_development_c_requirements>`.

For OSX and Windows users we recommending using
[conda](https://docs.conda.io/projects/conda/en/latest/)_,
and isolating development in a dedicated environment as follows::
[conda](https://docs.conda.io/projects/conda/en/latest/),
and isolating development in a dedicated environment as follows:

```bash
$ conda env create -f python/requirements/development.yml
Expand Down
Loading