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

Mention python3-venv and libpq-dev dependencies in contribution guide #11740

Merged
merged 4 commits into from
Jan 13, 2022
Merged

Mention python3-venv and libpq-dev dependencies in contribution guide #11740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3e26af9
Mention python3-venv and libpq-dev dependencies in contribution guide
andybalaam Jan 13, 2022
af59341
Changelog for 11740
andybalaam Jan 13, 2022
0c1e1b5
Improve wording of venv sentence
andybalaam Jan 13, 2022
c26bd5e
Improve wording of libpq-dev sentence.
andybalaam Jan 13, 2022
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
1 change: 1 addition & 0 deletions changelog.d/11740.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Mention python3-venv and libpq-dev dependencies in contribution guide.
4 changes: 3 additions & 1 deletion docs/development/contributing_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ recommended for development. More information about WSL can be found at
<https://docs.microsoft.com/en-us/windows/wsl/install>. Running Synapse natively
on Windows is not officially supported.

The code of Synapse is written in Python 3. To do pretty much anything, you'll need [a recent version of Python 3](https://wiki.python.org/moin/BeginnersGuide/Download).
The code of Synapse is written in Python 3. To do pretty much anything, you'll need [a recent version of Python 3](https://www.python.org/downloads/). Your Python also needs support for [virtual environments](https://docs.python.org/3/library/venv.html). This is usually built-in, but some Linux distributions like Debian and Ubuntu split it out into its own package. Running `sudo apt install python3-venv` should be enough.

Synapse can connect to PostgreSQL via the [psycopg2](https://pypi.org/project/psycopg2/) Python library. Building this library from source requires access to PostgreSQL's C header files. On Debian or Ubuntu Linux, these can be installed with `sudo apt install libpq-dev`.

The source code of Synapse is hosted on GitHub. You will also need [a recent version of git](https://github.com/git-guides/install-git).

Expand Down