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

Commit

Permalink
Minor improvements to poetry cheat sheet
Browse files Browse the repository at this point in the history
  • Loading branch information
David Robertson committed Jan 17, 2023
1 parent 99c32fe commit 927a050
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/development/dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

This is a quick cheat sheet for developers on how to use [`poetry`](https://python-poetry.org/).

# Installing

See the [contributing guide](contributing_guide.md#4-install-the-dependencies).

Developers should use Poetry 1.3.2 or higher. If you encounter problems related
to poetry, please [double-check your poetry version](#check-the-version-of-poetry-with-poetry---version).

# Background

Synapse uses a variety of third-party Python packages to function as a homeserver.
Expand Down Expand Up @@ -123,7 +130,7 @@ context of poetry's venv, without having to run `poetry shell` beforehand.
## ...reset my venv to the locked environment?

```shell
poetry install --extras all --remove-untracked
poetry install --all-extras --sync
```

## ...delete everything and start over from scratch?
Expand Down Expand Up @@ -195,7 +202,7 @@ poetry remove packagename
```

ought to do the trick. Alternatively, manually update `pyproject.toml` and
`poetry lock --no-update`. Include the updated `pyproject.toml` and poetry.lock`
`poetry lock --no-update`. Include the updated `pyproject.toml` and `poetry.lock`
files in your commit.

## ...update the version range for an existing dependency?
Expand Down

0 comments on commit 927a050

Please sign in to comment.