Skip to content

Commit

Permalink
Merge pull request #378 from ral-facilities/docs/new-poetry-installer…
Browse files Browse the repository at this point in the history
…-#376

docs: Update the poetry installation documentation
  • Loading branch information
Reillyhewitson authored Nov 3, 2022
2 parents 9bb898d + 1d43086 commit 2c64b7d
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,15 +103,26 @@ To maintain records of the API's dependencies,
command:

```bash
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
curl -sSL https://install.python-poetry.org | python3 -
```

The installation requires `~/.poetry/env` to be refreshed for changes to be applied.
Open a new terminal or execute the following command to ensure the installation is
completed smoothly:
The installation requires the following to be added to your `~/.bashrc` file so the installation folder is on your path.
```bash
export PATH="~/.local/bin:$PATH"
```
Then run `source ~/.bashrc` or open a new terminal and check poetry works by running `poetry --version`

If you encounter this error when installing poetry:
```
ERROR: No matching distribution found for poetry==1.2.0
```
You can try running the installer with python 3.8 with the command below:
```bash
source ~/.poetry/env
curl -sSL https://install.python-poetry.org | python3.8 -
```
Or you can specify the version you want to install from the listed versions with the command below:
```bash
curl -sSL https://install.python-poetry.org | python3 - --version 1.2.0
```

Before installing the API's dependencies, check the version of `setuptools`:
Expand Down Expand Up @@ -259,7 +270,7 @@ python3.8 --version
pyenv local 3.6.8 3.7.7 3.8.2

# Install Poetry
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
curl -sSL https://install.python-poetry.org | python3 -

# Apply changes made to file when installing Poetry
source ~/.poetry/env
Expand Down

0 comments on commit 2c64b7d

Please sign in to comment.