poetry README

The project's README from github.com/python-poetry/poetry. As one markdown file: README.md.

Poetry: Python packaging and dependency management made easy

Poetry Stable Version Pre-release Version Python Versions Download Stats Discord

Poetry helps you declare, manage and install dependencies of Python projects, ensuring you have the right stack everywhere.

Poetry Install

Poetry replaces setup.py, requirements.txt, setup.cfg, MANIFEST.in and Pipfile with a simple pyproject.toml based project format.

[build-system]
requires = ["poetry-core>=2.0.0,<3.0.0"]
build-backend = "poetry.core.masonry.api"

[project]
name = "my-package"
version = "0.1.0"
description = "The description of the package"
readme = "README.md"

license = "MIT"
license-files = ["LICENSE"]

# No Python upper bound for package metadata
requires-python = ">=3.9"

authors = [
    { name = "Sébastien Eustace", email = "[email protected]" },
]

# Keywords (translated to tags on the package index)
keywords = ["packaging", "poetry"]

dependencies = [
    # equivalent to ^3.8.1 with semver constraints
    "aiohttp (>=3.8.1,<4.0.0)",
    # dependency with extras
    "requests[security] (>=2.28,<3.0)",
    # version-specific dependency with prereleases allowed (see below)
    "tomli (>=2.0.1,<3.0.0) ; python_version < '3.11'",
    # git dependency with branch specified
    "cleo @ git+https://github.com/python-poetry/cleo.git@main",
]

[project.urls]
repository = "https://github.com/python-poetry/poetry"
homepage = "https://python-poetry.org"

# Scripts are easily expressed
[project.scripts]
my_package_cli = "my_package.console:run"

[project.optional-dependencies]
# optional dependency to be installed via 'poetry install -E my-extra'
my-extra = ["pendulum (>=3.1.0,<4.0.0)"]

[tool.poetry.dependencies]
# Python upper bound for locking
python = ">=3.9,<4.0"
# Version-specific dependencies with prereleases allowed
tomli = { allow-prereleases = true }

# Dependency groups are supported for organizing your dependencies
[dependency-groups]
dev = ["pytest (>=7.1.2,<8.0.0)", "pytest-cov (>=3.0,<4.0)"]
docs = ["Sphinx (>=5.1.1,<6.0.0)"]

# ...and can be installed only when explicitly requested
# via 'poetry install --with docs'
[tool.poetry.group.docs]
optional = true

# Alternatively, you can use Poetry specific syntax
# to specify dependency groups
[tool.poetry.group.lint]
optional = true

[tool.poetry.group.lint.dependencies]
ruff = ">=0.10.0"

Installation

Poetry supports multiple installation methods, including a simple script found at install.python-poetry.org. For full installation instructions, including advanced usage of the script, alternate install methods, and CI best practices, see the full installation documentation.

Documentation

Documentation for the current version of Poetry (as well as the development branch and recently out of support versions) is available from the official website.

Contribute

Poetry is a large, complex project always in need of contributors. For those new to the project, a list of suggested issues to work on in Poetry and poetry-core is available. The full contributing documentation also provides helpful guidance.

Resources

Supporters

Thanks to JetBrains for supporting us with licenses for their tools.

JetBrains logo.

poetry (python-poetry/poetry)

Searching Database…

34.3K ·GitHub
Poetry
Что это такое?Poetry — это консольная утилита для сборки пакетов Python и управления зависимостями: она описывает, отслеживает и устанавливает зависимости Python-проектов, чтобы у вас везде был правильный набор библиотек.
Как выглядит проект Poetry — мне по-прежнему нужны setup.py и requirements.txt?Нет — один файл pyproject.toml заменяет собой setup.py, requirements.txt, setup.cfg, MANIFEST.in и Pipfile в качестве формата проекта.
Я разрабатываю на Windows, а разворачиваю на серверах с Linux — будет ли работать и там, и там?Да — Poetry кроссплатформенная консольная утилита с официальной поддержкой Windows, macOS и Linux.
Что такое poetry-core?Это ядро Poetry без внешних зависимостей: оно служит системой сборки по стандарту PEP 517 для проектов Poetry и содержит основную функциональность фронтенда Poetry.
А requirements.txt для инструментов, которые его ждут, всё-таки можно получить?Да — официальный плагин poetry-plugin-export экспортирует проекты Poetry и lock-файлы в чужие форматы, например requirements.txt.
Нужен ли Poetry на боевом сервере, чтобы развернуть приложение?Не обязательно — плагин poetry-plugin-bundle устанавливает проекты Poetry или lock-файлы во внешние форматы, например виртуальные окружения.
Мы ставим инструменты в CI — Poetry там поддерживается?Да — в документации по установке описаны лучшие практики для CI, а также расширенные сценарии использования установочного скрипта и альтернативные способы установки.
What are similar projects?rye, pyinstaller, composer, pipx, uv, pip, swift-package-manager, CocoaPods
Which topics is it in?dependency-manager, toml, packaging, build-tool, package-manager, cli-tool, command-line, command-line-tool, free, tool, cli, python
Creator
python-poetry
Size
24.6 MB
Stars
34.3K
Updated
CommitOct 12Release2.5.1Sep 20
Age
8y
Commits · 90 Days