Poetry is a tool for dependency management and packaging in Python. It allows you to declare the libraries your project depends on and it will manage (install/update) them for you.
System requirements #
Poetry requires Python 2.7 or 3.5+. It is multi-platform and the goal is to make it work equally well on Windows, Linux and OSX.
Poetry provides a custom installer that will install
from the rest of your system by vendorizing its dependencies. This is the
recommended way of installing
get-poetry.pyscript described here will be replaced in Poetry 1.2 by
install.python-poetry.org. From Poetry 1.1.7 onwards, you can already use this script as described here.
osx / linux / bashonwindows install instructions #
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
windows powershell install instructions #
(Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python -
The installer installs the
poetry tool to Poetry’s
On Unix it is located at
$HOME/.poetry/bin and on Windows at
This directory will be automatically added to your
$PATH environment variable,
by appending a statement to your
$HOME/.profile configuration (or equivalent files).
If you do not feel comfortable with this, please pass the
--no-modify-path flag to
the installer and manually add the Poetry’s
bin directory to your path.
Finally, open a new shell and type the following:
If you see something like
Poetry 0.12.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
POETRY_UNINSTALL environment variable before executing the installer.
python get-poetry.py --uninstall POETRY_UNINSTALL=1 python get-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 get-poetry.py
If you want to install prerelease versions, you can do so by passing
or by using the
POETRY_PREVIEW environment variable:
python get-poetry.py --preview POETRY_PREVIEW=1 python get-poetry.py
Similarly, if you want to install a specific version, you can use
--version or the
python get-poetry.py --version 0.12.0 POETRY_VERSION=0.12.0 python get-poetry.py
The setup script must be able to find one of following executables in your shell’s path environment:
python(which can be a py3 or py2 interpreter)
Alternative installation methods (not recommended) #
Using alternative installation methods will make Poetry always use the Python version for which it has been installed to create virtualenvs.
So, you will need to install Poetry for each Python version you want to use and switch between them.
pip to install Poetry is possible.
pip install --user poetry
pipx to install Poetry is also possible.
pipx is used to install Python CLI applications globally while still isolating them in virtual environments. This allows for clean upgrades and uninstalls. pipx supports Python 3.6 and later. If using an earlier version of Python, consider pipsi.
pipx install poetry
pipx upgrade poetry
pipx uninstall poetry
Updating Poetry to the latest stable version is as simple as calling the
self update command.
poetry self update
If you want to install pre-release versions, you can use the
poetry self update --preview
And finally, if you want to install a specific version, you can pass it as an argument
poetry self update 0.8.0
self updatecommand will only work if you used the recommended installer to install Poetry.
Enable tab completion for Bash, Fish, or Zsh #
poetry supports generating completion scripts for Bash, Fish, and Zsh.
poetry help completions for full details, but the gist is as simple as using one of the following:
# Bash poetry completions bash > /etc/bash_completion.d/poetry.bash-completion # Bash (Homebrew) poetry completions bash > $(brew --prefix)/etc/bash_completion.d/poetry.bash-completion # Fish poetry completions fish > ~/.config/fish/completions/poetry.fish # Fish (Homebrew) poetry completions fish > (brew --prefix)/share/fish/vendor_completions.d/poetry.fish # Zsh poetry completions zsh > ~/.zfunc/_poetry # Oh-My-Zsh mkdir $ZSH_CUSTOM/plugins/poetry poetry completions zsh > $ZSH_CUSTOM/plugins/poetry/_poetry # prezto poetry completions zsh > ~/.zprezto/modules/completion/external/src/_poetry
zsh, you must then add the following line in your
oh-my-zsh, you must then enable poetry in your
plugins( poetry ... )