Skip to content

Commit fb3ae6a

Browse files
mkniewallnerneersighted
authored andcommitted
docs(README): consistently use install.python-poetry.org
1 parent e8d8f76 commit fb3ae6a

1 file changed

Lines changed: 24 additions & 18 deletions

File tree

README.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Python Poetry Installer
2+
23
This repository contains Poetry's official installation script, installer source and
34
related hosting configuration.
45

@@ -11,16 +12,21 @@ Poetry provides a custom installer that will install `poetry` isolated
1112
from the rest of your system.
1213

1314
### osx / linux / bashonwindows / Windows+MinGW install instructions
15+
1416
```bash
15-
curl -sSL https://install.python-poetry.org | python -
17+
curl -sSL https://install.python-poetry.org | python3 -
1618
```
19+
1720
### windows powershell install instructions
21+
1822
```powershell
19-
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python -
23+
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -
2024
```
2125

26+
> If you have installed Python through the Microsoft Store, replace `py` with `python` in the command above.
27+
2228
**Warning**: The previous `get-poetry.py` installer is now deprecated, if you are currently using it
23-
you should migrate to the new, supported, `install-poetry.py` installer.
29+
you should migrate to the new, supported, `install.python-poetry.org` installer.
2430

2531
The installer installs the `poetry` tool to Poetry's `bin` directory. This location depends on your system:
2632

@@ -41,44 +47,43 @@ poetry --version
4147
If you see something like `Poetry (version 1.2.0)` then you are ready to use Poetry.
4248
If you decide Poetry isn't your thing, you can completely remove it from your system
4349
by running the installer again with the `--uninstall` option or by setting
44-
the `POETRY_UNINSTALL` environment variable before executing the installer.
50+
the `POETRY_UNINSTALL` environment variable before executing the installer:
4551

4652
```bash
47-
python install-poetry.py --uninstall
48-
POETRY_UNINSTALL=1 python install-poetry.py
53+
curl -sSL https://install.python-poetry.org | python3 - --uninstall
54+
curl -sSL https://install.python-poetry.org | POETRY_UNINSTALL=1 python3 -
4955
```
5056

5157
By default, Poetry is installed into the user's platform-specific home directory.
5258
If you wish to change this, you may define the `POETRY_HOME` environment variable:
5359

5460
```bash
55-
POETRY_HOME=/etc/poetry python install-poetry.py
61+
curl -sSL https://install.python-poetry.org | POETRY_HOME=/etc/poetry python3 -
5662
```
5763

58-
If you want to install prerelease versions, you can do so by passing `--preview` option to `install-poetry.py`
59-
or by using the `POETRY_PREVIEW` environment variable:
64+
If you want to install prerelease versions, you can do so by passing `--preview` option or by using the `POETRY_PREVIEW`
65+
environment variable:
6066

6167
```bash
62-
python install-poetry.py --preview
63-
POETRY_PREVIEW=1 python install-poetry.py
68+
curl -sSL https://install.python-poetry.org | python3 - --preview
69+
curl -sSL https://install.python-poetry.org | POETRY_PREVIEW=1 python3 -
6470
```
6571

6672
Similarly, if you want to install a specific version, you can use `--version` option or the `POETRY_VERSION`
6773
environment variable:
6874

6975
```bash
70-
python install-poetry.py --version 1.2.0
71-
POETRY_VERSION=1.2.0 python install-poetry.py
76+
curl -sSL https://install.python-poetry.org | python3 - --version 1.2.0
77+
curl -sSL https://install.python-poetry.org | POETRY_VERSION=1.2.0 python3 -
7278
```
7379

7480
You can also install Poetry for a `git` repository by using the `--git` option:
7581

7682
```bash
77-
python install-poetry.py --git https://github.com/python-poetry/poetry.git@master
83+
curl -sSL https://install.python-poetry.org | python3 - --git https://github.com/python-poetry/poetry.git@master
7884
````
7985

80-
**Note**: Note that the installer does not support Python < 3.6.
81-
86+
> **Note**: The installer does not support Python < 3.6.
8287

8388
## Known Issues
8489

@@ -91,6 +96,7 @@ details issues we are presently aware of, and potential workarounds.
9196
> **Note:** This can also affect WSL users on Windows.
9297

9398
#### Installation Layout
99+
94100
If you encounter an error similar to the following, this might be due to
95101
[pypa/virtualenv#2350](https://github.com/pypa/virtualenv/issues/2350).
96102

@@ -101,7 +107,7 @@ FileNotFoundError: [Errno 2] No such file or directory: '/root/.local/share/pypo
101107
You can work around this issue by setting the `DEB_PYTHON_INSTALL_LAYOUT` environment
102108
variable to `deb` in order to emulate previously working behaviour.
103109

104-
```sh
110+
```bash
105111
export DEB_PYTHON_INSTALL_LAYOUT=deb
106112
```
107113

@@ -120,7 +126,7 @@ See also [pypa/get-pip#124](https://github.com/pypa/get-pip/issues/124).
120126
The known workaround for this issue is to reinstall the `distutils` package provided by
121127
the distribution.
122128

123-
```sh
129+
```bash
124130
apt-get install --reinstall python3-distutils
125131
```
126132

0 commit comments

Comments
 (0)