ac6fb50a38
This is part of a major overhaul of the installer I hope to complete in a relatively short time. This first pass makes sure we use consistent directories on all platforms by preferring the documented paths to a possibly unexpected `site.getuserbase()` (which results in a Library path on macOS Framework builds, like Homebrew and OS-provided Pythons). Path handling as a whole is updated to take advantage of `pathlib` and DRY up some tedious code. It also starts the first stage of increasing use of classes and careful thought as to the visibility of class-level attributes in this script -- I hope to end up with a DSL-like end result that is as informative as possible to the reader of this script. |
||
|---|---|---|
| .github/workflows | ||
| .flake8 | ||
| .gitignore | ||
| .pre-commit-config.yaml | ||
| install-poetry.py | ||
| pyproject.toml | ||
| README.md | ||
| vercel.json | ||
Python Poetry Installer
This repository contains Poetry's official installation script, installer source and related hosting configuration.
The script is hosted on Vercel and made available at https://install.python-poetry.org/.
Usage
Poetry provides a custom installer that will install poetry isolated
from the rest of your system.
osx / linux / bashonwindows / Windows+MinGW install instructions
curl -sSL https://install.python-poetry.org | python -
windows powershell install instructions
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python -
Warning: The previous get-poetry.py installer is now deprecated, if you are currently using it
you should migrate to the new, supported, install-poetry.py installer.
The installer installs the poetry tool to Poetry's bin directory. This location depends on your system:
$HOME/.local/binfor Unix%APPDATA%\Python\Scriptson Windows
If this directory is not on your PATH, you will need to add it manually
if you want to invoke Poetry with simply poetry.
Alternatively, you can use the full path to poetry to use it.
Once Poetry is installed you can execute the following:
poetry --version
If you see something like Poetry (version 1.2.0) then you are ready to use Poetry.
If you decide Poetry isn't your thing, you can completely remove it from your system
by running the installer again with the --uninstall option or by setting
the POETRY_UNINSTALL environment variable before executing the installer.
python install-poetry.py --uninstall
POETRY_UNINSTALL=1 python install-poetry.py
By default, Poetry is installed into the user's platform-specific home directory.
If you wish to change this, you may define the POETRY_HOME environment variable:
POETRY_HOME=/etc/poetry python install-poetry.py
If you want to install prerelease versions, you can do so by passing --preview option to install-poetry.py
or by using the POETRY_PREVIEW environment variable:
python install-poetry.py --preview
POETRY_PREVIEW=1 python install-poetry.py
Similarly, if you want to install a specific version, you can use --version option or the POETRY_VERSION
environment variable:
python install-poetry.py --version 1.2.0
POETRY_VERSION=1.2.0 python install-poetry.py
You can also install Poetry for a git repository by using the --git option:
python install-poetry.py --git https://github.com/python-poetry/poetry.git@master
Note: Note that the installer does not support Python < 3.6.
Known Issues
Debian/Ubuntu
On Debian and Ubuntu systems, there are various issues that maybe caused due to how various Python standard library components are packaged and configured. The following details issues we are presently aware of, and potential workarounds.
Note: This can also affect WSL users on Windows.
Installation Layout
If you encounter an error similar to the following, this might be due to pypa/virtualenv#2350.
FileNotFoundError: [Errno 2] No such file or directory: '/root/.local/share/pypoetry/venv/bin/python'
You can work around this issue by setting the DEB_PYTHON_INSTALL_LAYOUT environment
variable to deb in order to emulate previously working behaviour.
export DEB_PYTHON_INSTALL_LAYOUT=deb
Missing distutils Module
In certain Debian/Ubuntu environments, you might encounter the following error message
in error logs (poetry-installer-error-*.log) provided when the installer fails.
ModuleNotFoundError: No module named 'distutils.cmd'
This is probably due to this bug. See also pypa/get-pip#124.
The known workaround for this issue is to reinstall the distutils package provided by
the distribution.
apt-get install --reinstall python3-distutils
If you have installed a specific python version, eg: 3.10, you might have to use the
package name python3.10-distutils.