Skip to content

Commit

Permalink
More detailed development installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
juhoinkinen authored Sep 13, 2022
1 parent 1287575 commit 4a6e2b5
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,18 +62,23 @@ Clone the repository.

Switch into the repository directory.

Install [pipx](https://pypa.github.io/pipx/) and Poetry if you don't have them:
Install [pipx](https://pypa.github.io/pipx/) and Poetry if you don't have them. First pipx:

python3 -m pip install --user pipx
python3 -m pipx ensurepath

Open a new shell, and then install Poetry:

pipx install poetry

Poetry can be installed also without pipx: check the [Poetry documentation](https://python-poetry.org/docs/master/#installation).
Poetry can be installed also without pipx: check the [Poetry documentation](https://python-poetry.org/docs/master/#installation).

Create a virtual environment and install dependencies (by default development dependencies are included; use option `-E` to install selected optional dependencies, or install all of them with `--all-extras`):
Create a virtual environment and install dependencies:

poetry install

By default development dependencies are included. Use option `-E` to install dependencies for selected optional features (`-E "extra1 extra2"` for multiple extras), or install all of them with `--all-extras`. By default the virtual environment directory is not under the project directory, but there is a [setting for selecting this](https://python-poetry.org/docs/configuration/#virtualenvsin-project).

Enter the virtual environment:

poetry shell
Expand Down

0 comments on commit 4a6e2b5

Please sign in to comment.