소스 검색

Adding venv installation documentation (#508)

Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
Virag Jain 1 일 전
부모
커밋
14eea8732a
1개의 변경된 파일14개의 추가작업 그리고 16개의 파일을 삭제
  1. 14 16
      readme.md

+ 14 - 16
readme.md

@@ -33,11 +33,11 @@ This demo is aimed primarily at developers wanting to learn more about the inter
 - [Gitpod](#setup-with-gitpod)
 - [Vagrant](#setup-with-vagrant)
 - [Docker](#setup-with-docker)
-- [Virtualenv](#setup-with-virtualenv)
+- [Venv](#setup-with-venv)
 
 If you want to see what Wagtail is all about, we suggest trying it out through [Gitpod](#setup-with-gitpod).
 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.
-Developers more familiar with virtualenv and traditional Django app setup instructions should skip to [Setup with virtualenv](#setup-with-virtualenv).
+Developers more familiar with venv/virtualenv and traditional Django app setup instructions should skip to [Setup with venv](#setup-with-venv).
 
 ## Setup with Gitpod
 
@@ -119,31 +119,29 @@ To tail the logs from the Docker containers in realtime, run:
 docker compose logs -f
 ```
 
-## Setup with Virtualenv
+## Setup with venv
 
-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.
+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.
 
 #### Dependencies
 
-- Python 3.10, 3.11, 3.12 or 3.13
-- [Virtualenv](https://virtualenv.pypa.io/en/stable/installation.html)
-- [VirtualenvWrapper](https://virtualenvwrapper.readthedocs.io/en/latest/install.html) (optional)
+- Python 3.10+
+- [venv](https://docs.python.org/3/library/venv.html)
 
 ### Installation
 
-With [PIP](https://github.com/pypa/pip) and [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/)
-installed, run:
+On GNU/Linux or macOS (bash):
+
 ```bash
-mkvirtualenv wagtailbakerydemo
-python --version
+python -m venv .venv
+source .venv/bin/activate
 ```
 
-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:
+On Windows (cmd.exe), run the following commands:
 ```bash
-deactivate
-rmvirtualenv wagtailbakerydemo
-mkvirtualenv wagtailbakerydemo --python=python3.12
-python --version
+.venv\Scripts\activate.bat
+# if wagtailbakerydemo\Scripts\activate.bat doesn't work, run:
+.venv\Scripts\Activate.ps1
 ```
 
 Now we're ready to set up the bakery demo project itself: