Poetry: Python packaging and dependency management made easy

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.

[tool.poetry]
name = "my-package"
version = "0.1.0"
description = "The description of the package"

license = "MIT"

authors = [
    "Sébastien Eustace <[email protected]>"
]

repository = "https://github.com/python-poetry/poetry"
homepage = "https://python-poetry.org"

# README file(s) are used as the package description
readme = ["README.md", "LICENSE"]

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

[tool.poetry.dependencies]
# Compatible Python versions
python = ">=3.8"
# Standard dependency with semver constraints
aiohttp = "^3.8.1"
# Dependency with extras
requests = { version = "^2.28", extras = ["security"] }
# Version-specific dependencies with prereleases allowed
tomli = { version = "^2.0.1", python = "<3.11", allow-prereleases = true }
# Git dependencies
cleo = { git = "https://github.com/python-poetry/cleo.git", branch = "master" }
# Optional dependencies (installed by extras)
pendulum = { version = "^2.1.2", optional = true }

# Dependency groups are supported for organizing your dependencies
[tool.poetry.group.dev.dependencies]
pytest = "^7.1.2"
pytest-cov = "^3.0"

# ...and can be installed only when explicitly requested
[tool.poetry.group.docs]
optional = true
[tool.poetry.group.docs.dependencies]
Sphinx = "^5.1.1"

# Python-style entrypoints and scripts are easily expressed
[tool.poetry.scripts]
my-script = "my_package:main"

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

Related Projects

poetry-core: PEP 517 build-system for Poetry projects, and dependency-free core functionality of the Poetry frontend
poetry-plugin-export: Export Poetry projects/lock files to foreign formats like requirements.txt
poetry-plugin-bundle: Install Poetry projects/lock files to external formats like virtual environments
install.python-poetry.org: The official Poetry installation script
website: The official Poetry website and blog

Project Name	Stars	Repos Using This	Packages Using This	Most Recent Commit	Total Releases	Latest Release	Open Issues	License	Language
Poetry	25,270	32	123	12 hours ago	153	August 31, 2022	610	mit	Python
Python packaging and dependency management made easy
Poet	317			5 years ago	9	April 26, 2017	13	mit	Python
Poet helps you declare, manage and install dependencies of Python projects, ensuring you have the right stack everywhere.
Serverless Jetpack	273	2	5	3 days ago	29	June 07, 2021	105	mit	JavaScript
A faster JavaScript packager for Serverless applications.
Autovalueannotations	228	28		5 years ago	5	August 23, 2017			Shell
A standalone packaging of the annotations from Google's AutoValue library.
Fades	186	1		a year ago	12	May 23, 2022	13	gpl-3.0	Python
fades is a system that automatically handles the virtualenvs in the cases normally found when writing scripts and simple programs, and even helps to administer big projects.
Rain	77			3 years ago				mit	Python
🌧️ A live example to illustrate python packaging, testing, building, & deploying
Packageproject.cmake	69			6 days ago			6	mit	CMake
🏛️ Help other developers use your project. A CMake script for packaging C/C++ projects for simple project installation while employing best-practices for maximum compatibility.
Comphar	66			a year ago	3	February 16, 2019	1	mit	PHP
Pack all composer dependencies into a single phar file.
Package Config Checker	49		1	6 years ago	4	February 03, 2017	7	mit	JavaScript
Checks if your dependencies have package.json files config or an .npmignore for packaging
Yarn Plugin Nixify	48			11 days ago			11	bsd-2-clause	TypeScript
Yarn v3 plugin to help with Nix packaging