

GitHub - python-poetry/poetry: Python dependency management and packaging made e...
source link: https://github.com/python-poetry/poetry
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

README.md
Poetry: Dependency Management for Python
Poetry helps you declare, manage and install dependencies of Python projects, ensuring you have the right stack everywhere.
It supports Python 2.7 and 3.4+.
The complete documentation is available on the official website.
Installation
Poetry provides a custom installer that will install poetry
isolated
from the rest of your system by vendorizing its dependencies. This is the
recommended way of installing poetry
.
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
Alternatively, you can download the get-poetry.py
file and execute it separately.
If you want to install prerelease versions, you can do so by passing --preview
to get-poetry.py
:
python get-poetry.py --preview
Similarly, if you want to install a specific version, you can use --version
:
python get-poetry.py --version 0.7.0
Using pip
to install poetry
is also possible.
pip install --user poetry
Be aware, however, that it will also install poetry's dependencies which might cause conflicts.
Updating 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 prerelease versions, you can use the --preview
option.
poetry self update --preview
And finally, if you want to install a specific version you can pass it as an argument
to self update
.
poetry self update 1.0.0
!!!note
If you are still on poetry version < 1.0 use `poetry self:update` instead.
Enable tab completion for Bash, Fish, or Zsh
poetry
supports generating completion scripts for Bash, Fish, and Zsh.
See 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 (macOS/Homebrew) poetry completions bash > $(brew --prefix)/etc/bash_completion.d/poetry.bash-completion # Fish poetry completions fish > ~/.config/fish/completions/poetry.fish # Zsh poetry completions zsh > ~/.zfunc/_poetry # Zsh (macOS/Homebrew) poetry completions zsh > $(brew --prefix)/share/zsh/site-functions/_poetry
Note: you may need to restart your shell in order for the changes to take effect.
For zsh
, you must then add the following line in your ~/.zshrc
before
compinit
(not for homebrew setup):
fpath+=~/.zfunc
Introduction
poetry
is a tool to handle dependency installation as well as building and packaging of Python packages.
It only needs one file to do all of that: the new, standardized pyproject.toml
.
In other words, poetry uses pyproject.toml
to replace setup.py
, requirements.txt
, setup.cfg
, MANIFEST.in
and the newly added Pipfile
.
[tool.poetry] name = "my-package" version = "0.1.0" description = "The description of the package" license = "MIT" authors = [ "Sébastien Eustace <[email protected]>" ] readme = 'README.md' # Markdown files are supported repository = "https://github.com/python-poetry/poetry" homepage = "https://github.com/python-poetry/poetry" keywords = ['packaging', 'poetry'] [tool.poetry.dependencies] python = "~2.7 || ^3.2" # Compatible python versions must be declared here toml = "^0.9" # Dependencies with extras requests = { version = "^2.13", extras = [ "security" ] } # Python specific dependencies with prereleases allowed pathlib2 = { version = "^2.2", python = "~2.7", allow-prereleases = true } # Git dependencies cleo = { git = "https://github.com/sdispater/cleo.git", branch = "master" } # Optional dependencies (extras) pendulum = { version = "^1.4", optional = true } [tool.poetry.dev-dependencies] pytest = "^3.0" pytest-cov = "^2.4" [tool.poetry.scripts] my-script = 'my_package:main'
There are some things we can notice here:
- It will try to enforce semantic versioning as the best practice in version naming.
- You can specify the readme, included and excluded files: no more
MANIFEST.in
.poetry
will also use VCS ignore files (like.gitignore
) to populate theexclude
section. - Keywords (up to 5) can be specified and will act as tags on the packaging site.
- The dependencies sections support caret, tilde, wildcard, inequality and multiple requirements.
- You must specify the python versions for which your package is compatible.
poetry
will also detect if you are inside a virtualenv and install the packages accordingly.
So, poetry
can be installed globally and used everywhere.
poetry
also comes with a full fledged dependency resolution library.
Why?
Packaging systems and dependency management in Python are rather convoluted and hard to understand for newcomers.
Even for seasoned developers it might be cumbersome at times to create all files needed in a Python project: setup.py
,
requirements.txt
, setup.cfg
, MANIFEST.in
and the newly added Pipfile
.
So I wanted a tool that would limit everything to a single configuration file to do: dependency management, packaging and publishing.
It takes inspiration in tools that exist in other languages, like composer
(PHP) or cargo
(Rust).
And, finally, there is no reliable tool to properly resolve dependencies in Python, so I started poetry
to bring an exhaustive dependency resolver to the Python community.
What about Pipenv?
In short: I do not like the CLI it provides, or some of the decisions made, and I think we can make a better and more intuitive one. Here are a few things that I don't like.
Dependency resolution
The dependency resolution is erratic and will fail even if there is a solution. Let's take an example:
pipenv install oslo.utils==1.4.0
will fail with this error:
Could not find a version that matches pbr!=0.7,!=2.1.0,<1.0,>=0.6,>=2.0.0
while Poetry will get you the right set of packages:
poetry add oslo.utils=1.4.0
results in :
- Installing pytz (2018.3)
- Installing netifaces (0.10.6)
- Installing netaddr (0.7.19)
- Installing oslo.i18n (2.1.0)
- Installing iso8601 (0.1.12)
- Installing six (1.11.0)
- Installing babel (2.5.3)
- Installing pbr (0.11.1)
- Installing oslo.utils (1.4.0)
This is possible thanks to the efficient dependency resolver at the heart of Poetry.
Here is a breakdown of what exactly happens here:
oslo.utils (1.4.0)
depends on:
pbr (>=0.6,!=0.7,<1.0)
Babel (>=1.3)
six (>=1.9.0)
iso8601 (>=0.1.9)
oslo.i18n (>=1.3.0)
netaddr (>=0.7.12)
netifaces (>=0.10.4)
What interests us is pbr (>=0.6,!=0.7,<1.0)
.
At this point, poetry will choose pbr==0.11.1
which is the latest version that matches the constraint.
Next it will try to select oslo.i18n==3.20.0
which is the latest version that matches oslo.i18n (>=1.3.0)
.
However this version requires pbr (!=2.1.0,>=2.0.0)
which is incompatible with pbr==0.11.1
,
so poetry
will try to find a version of oslo.i18n
that satisfies pbr (>=0.6,!=0.7,<1.0)
.
By analyzing the releases of oslo.i18n
, it will find oslo.i18n==2.1.0
which requires pbr (>=0.11,<2.0)
.
At this point the rest of the resolution is straightforward since there is no more conflict.
Resources
Recommend
-
95
README.md Poetry: Dependency Management for Python
-
64
点击上方“Python开发”,选择“置顶公众号” 关键时刻,第一时间送达! ...
-
19
Deterministic builds Develop Poetry comes with all the tools you might need to manage your projects in a deterministic way. ...
-
6
@vikaszVikas ZAI/Deep Learning/NLP, DevOps/AutomationCreate a new Poetry project:0 reactions# poetry new <project-name...
-
10
Miniconda 和 poetry 搭建 Python 开发环境(支持多版本、依赖管理) 发表于 2021-0...
-
5
V2EX › 程序员 poetry 试图解决 Python 世界里的什么难题? AndyAO · 7 小时 16 分钟前 ·...
-
6
Dependency Management With Python Poetry ...
-
7
Poetry Kernel Use per-directory Poetry environments to run Jupyter kernels. No need to install a Jupyter kernel per Python virtual environment! The idea behind this project is to allow you to capture the exact state of your en...
-
6
Solving Sudoku with Poetry's dependency resolverAn unexpected use case for one of Python's most popular package managers.While waiting for/sitting on various types of transportation during the recent spike in demand fo...
-
7
You can't force poetry Keep Your Python Project in Check With Poetry 1.2 Python
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK