Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Updating README.rst #8746

Merged
merged 3 commits into from
Nov 13, 2020
Merged

Updating README.rst #8746

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
de0a3c3
Update README.rst
chagai95 Nov 12, 2020
af7172e
Some minor wording changes
anoadragon453 Nov 13, 2020
c173b57
Add changelog
anoadragon453 Nov 13, 2020
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
10 changes: 7 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,20 +259,24 @@ to install using pip and a virtualenv::
python3 -m venv ./env
source ./env/bin/activate
pip install -e ".[all,test]"

This will run a process of downloading and installing all the needed
dependencies into a virtual env.

Some of the dependencies might have to be installed manually, if you run into errors just install the dependency that is mentioned in the error manually.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious - in what case was this necessary for you? What errors did you see?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Someone answered this in #synapse-dev, stating that it helped to install dependencies individually when using export HTTP_PROXY on their system.

I'm aware this can also be an issue with resource-constrained devices - installing everyone at once can cause pip to overwhelm the system's available memory.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't remember the exact modules that were necessary, but there were definitely a few...


Once this is done, you may wish to run Synapse's unit tests, to
check that everything is installed as it should be::

python -m twisted.trial tests

This should end with a 'PASSED' result::

Ran 1266 tests in 643.930s
Ran 1332 tests in 716.064s

PASSED (skips=15, successes=1317)

PASSED (skips=15, successes=1251)
(The amount of tests may change in the future...)

Running the Integration Tests
=============================
Expand Down