Skip to content

Commit

Permalink
developer_docs.md: add OS specific instructions to python3-venv section
Browse files Browse the repository at this point in the history
  • Loading branch information
odscjen committed Aug 4, 2023
1 parent 1407929 commit c96fb0b
Showing 1 changed file with 33 additions and 15 deletions.
48 changes: 33 additions & 15 deletions developer_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ git submodule update

#### Create and activate a Python virtual environment

The following instructions assume you have python installed on your machine.

You can use either `pyenv` or `python3-venv`:

##### pyenv
Expand All @@ -79,23 +81,39 @@ You can use either `pyenv` or `python3-venv`:

##### python3-venv

1. Install [python3-venv](https://docs.python.org/3/library/venv.html).

```bash
sudo apt-get install python3-venv
```

1. Create a virtual environment.

```bash
python3 -m venv .ve
```
If you are using Python 3.3 or newer, the `venv` is included in the Python standard library and requires no additional installation.

1. Install [python3-venv](https://docs.python.org/3/library/venv.html).
a. Linux users
```bash
sudo apt-get install python3-venv
```
b. MacOS users
```bash
pip3 install venv
```
c. Windows users
```bash
py -m pip install venv
```
1. Create a virtual environment called .ve.
a. Linux/MacOS users
```bash
python3 -m venv .ve
```
a. Windows users
```bash
py -m venv .ve
```
1. Activate the virtual environment. You must run this command for each new terminal session.

```bash
source .ve/bin/activate
```
a. Linux/MacOS users
```bash
source .ve/bin/activate
```
b. Windows users
```bash
.\env\Scripts\activate
```

#### Install requirements

Expand Down

0 comments on commit c96fb0b

Please sign in to comment.