Skip to content

Commit 14eea87

Browse files
Adding venv installation documentation (wagtail#508)
Co-authored-by: Thibaud Colas <[email protected]>
1 parent 7c19ba7 commit 14eea87

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

readme.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ This demo is aimed primarily at developers wanting to learn more about the inter
3333
- [Gitpod](#setup-with-gitpod)
3434
- [Vagrant](#setup-with-vagrant)
3535
- [Docker](#setup-with-docker)
36-
- [Virtualenv](#setup-with-virtualenv)
36+
- [Venv](#setup-with-venv)
3737

3838
If you want to see what Wagtail is all about, we suggest trying it out through [Gitpod](#setup-with-gitpod).
3939
If you want to set up Wagtail locally instead, and you're new to Python and/or Django, we suggest you run this project on a Virtual Machine using [Vagrant](#setup-with-vagrant) or [Docker](#setup-with-docker) (whichever you're most comfortable with). Both Vagrant and Docker will help resolve common software dependency issues.
40-
Developers more familiar with virtualenv and traditional Django app setup instructions should skip to [Setup with virtualenv](#setup-with-virtualenv).
40+
Developers more familiar with venv/virtualenv and traditional Django app setup instructions should skip to [Setup with venv](#setup-with-venv).
4141

4242
## Setup with Gitpod
4343

@@ -119,31 +119,29 @@ To tail the logs from the Docker containers in realtime, run:
119119
docker compose logs -f
120120
```
121121

122-
## Setup with Virtualenv
122+
## Setup with venv
123123

124-
You can run the Wagtail demo locally without setting up Vagrant or Docker and simply use Virtualenv, which is the [recommended installation approach](https://docs.djangoproject.com/en/stable/topics/install/#install-the-django-code) for Django itself.
124+
You can run the Wagtail demo locally without setting up Vagrant or Docker and simply use venv, which is the [recommended installation approach](https://docs.djangoproject.com/en/5.2/topics/install/#install-the-django-code) for Django itself.
125125

126126
#### Dependencies
127127

128-
- Python 3.10, 3.11, 3.12 or 3.13
129-
- [Virtualenv](https://virtualenv.pypa.io/en/stable/installation.html)
130-
- [VirtualenvWrapper](https://virtualenvwrapper.readthedocs.io/en/latest/install.html) (optional)
128+
- Python 3.10+
129+
- [venv](https://docs.python.org/3/library/venv.html)
131130

132131
### Installation
133132

134-
With [PIP](https://github.com/pypa/pip) and [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/)
135-
installed, run:
133+
On GNU/Linux or macOS (bash):
134+
136135
```bash
137-
mkvirtualenv wagtailbakerydemo
138-
python --version
136+
python -m venv .venv
137+
source .venv/bin/activate
139138
```
140139

141-
Confirm that this is showing a compatible version of Python 3.x. If not, and you have multiple versions of Python installed on your system, you may need to specify the appropriate version when creating the virtualenv:
140+
On Windows (cmd.exe), run the following commands:
142141
```bash
143-
deactivate
144-
rmvirtualenv wagtailbakerydemo
145-
mkvirtualenv wagtailbakerydemo --python=python3.12
146-
python --version
142+
.venv\Scripts\activate.bat
143+
# if wagtailbakerydemo\Scripts\activate.bat doesn't work, run:
144+
.venv\Scripts\Activate.ps1
147145
```
148146

149147
Now we're ready to set up the bakery demo project itself:

0 commit comments

Comments
 (0)