From 1c7258ece57b320aa89f00278de917ad1f6f5a03 Mon Sep 17 00:00:00 2001
From: manuroe <manu@matrix.org>
Date: Fri, 4 Nov 2022 11:43:44 +0100
Subject: [PATCH] Doc: Update the synapse installation section with poetry
 usage

---
 changelog.d/pr-7521.doc   |  1 +
 docs/integration_tests.md | 38 ++++++++------------------------------
 2 files changed, 9 insertions(+), 30 deletions(-)
 create mode 100644 changelog.d/pr-7521.doc

diff --git a/changelog.d/pr-7521.doc b/changelog.d/pr-7521.doc
new file mode 100644
index 00000000000..b1b838394a3
--- /dev/null
+++ b/changelog.d/pr-7521.doc
@@ -0,0 +1 @@
+Doc: Explain in docs/integration_tests.md how to use Python poetry to install synapse locally
\ No newline at end of file
diff --git a/docs/integration_tests.md b/docs/integration_tests.md
index b5a830e7ffd..afcb4b16ab8 100644
--- a/docs/integration_tests.md
+++ b/docs/integration_tests.md
@@ -31,10 +31,12 @@ The documentation describes what we do to have one, using [Synapse](https://gith
 
 Steps:
 
-- Install virtualenv
+- Install poetry
 
 ```bash
-python3 -m pip install virtualenv
+pip install --user pipx
+pipx install poetry
+python3 -m pipx ensurepath   # To run if `pipx install poetry` complained about PATH not being correctly set 
 ```
 
 - Clone Synapse repository
@@ -52,11 +54,8 @@ You should have the develop branch cloned by default.
 - Run synapse, from the Synapse folder you just cloned
 
 ```bash
-virtualenv -p python3 env
-source env/bin/activate
-pip install -e .
-demo/start.sh --no-rate-limit
-
+poetry install --extras all
+poetry run ./demo/start.sh --no-rate-limit
 ```
 
 Alternatively, to install the latest Synapse release package (and not a cloned branch) you can run the following instead of `git clone` and `pip install -e .`:
@@ -86,13 +85,7 @@ It can be done using this command:
 To stop Synapse, you can run the following commands:
 
 ```bash
-./demo/stop.sh
-```
-
-And you can deactivate the virtualenv:
-
-```bash
-deactivate
+poetry run ./demo/stop.sh
 ```
 
 ## Troubleshoot
@@ -113,19 +106,4 @@ Ensure you have the following configuration in `demo/etc/8080.config`.
 public_baseurl: http://10.0.2.2:8080/
 ```
 
-After changing this you will need to restart synapse using `demo/stop.sh` and `demo/start.sh` to load the new configuration.
-
-### virtualenv command fails
-
-You can try using
-```bash
-python3 -m venv env
-```
-or
-```bash
-python3 -m virtualenv env
-```
-instead of
-```bash
-virtualenv -p python3 env
-```
+After changing this you will need to restart synapse using `poetry run demo/stop.sh` and `poetry run demo/start.sh` to load the new configuration.