# Poetry: Python packaging and dependency management made easy
[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
[![Stable Version](https://img.shields.io/pypi/v/poetry?label=stable)][PyPI Releases]
[![Pre-release Version](https://img.shields.io/github/v/release/python-poetry/poetry?label=pre-release&include_prereleases&sort=semver)][PyPI Releases]
[![Python Versions](https://img.shields.io/pypi/pyversions/poetry)][PyPI]
[![Download Stats](https://img.shields.io/pypi/dm/poetry)](https://pypistats.org/packages/poetry)
[![Discord](https://img.shields.io/discord/487711540787675139?logo=discord)][Discord]
Poetry helps you declare, manage and install dependencies of Python projects,
ensuring you have the right stack everywhere.
![Poetry Install](https://raw.githubusercontent.com/python-poetry/poetry/master/assets/install.gif)
Poetry replaces `setup.py`, `requirements.txt`, `setup.cfg`, `MANIFEST.in` and `Pipfile` with a simple `pyproject.toml`
based project format.
```toml
[tool.poetry]
name = "my-package"
version = "0.1.0"
description = "The description of the package"
license = "MIT"
authors = [
"Sébastien Eustace <sebastien@eustace.io>"
]
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 = "main" }
# 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
* [Releases][PyPI Releases]
* [Official Website]
* [Documentation]
* [Issue Tracker]
* [Discord]
[PyPI]: https://pypi.org/project/poetry/
[PyPI Releases]: https://pypi.org/project/poetry/#history
[Official Website]: https://python-poetry.org
[Documentation]: https://python-poetry.org/docs/
[Issue Tracker]: https://github.com/python-poetry/poetry/issues
[Suggested Issues]: https://github.com/python-poetry/poetry/contribute
[Contributing Documentation]: https://python-poetry.org/docs/contributing
[Discord]: https://discord.com/invite/awxPgve
[install.python-poetry.org]: https://install.python-poetry.org
[Installation Documentation]: https://python-poetry.org/docs/#installation
## Related Projects
* [poetry-core](https://github.com/python-poetry/poetry-core): PEP 517 build-system for Poetry projects, and
dependency-free core functionality of the Poetry frontend
* [poetry-plugin-export](https://github.com/python-poetry/poetry-plugin-export): Export Poetry projects/lock files to
foreign formats like requirements.txt
* [poetry-plugin-bundle](https://github.com/python-poetry/poetry-plugin-bundle): Install Poetry projects/lock files to
external formats like virtual environments
* [install.python-poetry.org](https://github.com/python-poetry/install.python-poetry.org): The official Poetry
installation script
* [website](https://github.com/python-poetry/website): The official Poetry website and blog
Raw data
{
"_id": null,
"home_page": "https://python-poetry.org/",
"name": "poetry",
"maintainer": "Arun Babu Neelicattu",
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": "arun.neelicattu@gmail.com",
"keywords": "packaging, dependency, poetry",
"author": "S\u00e9bastien Eustace",
"author_email": "sebastien@eustace.io",
"download_url": "https://files.pythonhosted.org/packages/29/84/dbf6db6ecf3cbb2926c05a0b831bb03559c15b700d9836c8afc9022bcedb/poetry-1.8.4.tar.gz",
"platform": null,
"description": "# Poetry: Python packaging and dependency management made easy\n\n[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)\n[![Stable Version](https://img.shields.io/pypi/v/poetry?label=stable)][PyPI Releases]\n[![Pre-release Version](https://img.shields.io/github/v/release/python-poetry/poetry?label=pre-release&include_prereleases&sort=semver)][PyPI Releases]\n[![Python Versions](https://img.shields.io/pypi/pyversions/poetry)][PyPI]\n[![Download Stats](https://img.shields.io/pypi/dm/poetry)](https://pypistats.org/packages/poetry)\n[![Discord](https://img.shields.io/discord/487711540787675139?logo=discord)][Discord]\n\nPoetry helps you declare, manage and install dependencies of Python projects,\nensuring you have the right stack everywhere.\n\n![Poetry Install](https://raw.githubusercontent.com/python-poetry/poetry/master/assets/install.gif)\n\nPoetry replaces `setup.py`, `requirements.txt`, `setup.cfg`, `MANIFEST.in` and `Pipfile` with a simple `pyproject.toml`\nbased project format.\n\n```toml\n[tool.poetry]\nname = \"my-package\"\nversion = \"0.1.0\"\ndescription = \"The description of the package\"\n\nlicense = \"MIT\"\n\nauthors = [\n \"S\u00e9bastien Eustace <sebastien@eustace.io>\"\n]\n\nrepository = \"https://github.com/python-poetry/poetry\"\nhomepage = \"https://python-poetry.org\"\n\n# README file(s) are used as the package description\nreadme = [\"README.md\", \"LICENSE\"]\n\n# Keywords (translated to tags on the package index)\nkeywords = [\"packaging\", \"poetry\"]\n\n[tool.poetry.dependencies]\n# Compatible Python versions\npython = \">=3.8\"\n# Standard dependency with semver constraints\naiohttp = \"^3.8.1\"\n# Dependency with extras\nrequests = { version = \"^2.28\", extras = [\"security\"] }\n# Version-specific dependencies with prereleases allowed\ntomli = { version = \"^2.0.1\", python = \"<3.11\", allow-prereleases = true }\n# Git dependencies\ncleo = { git = \"https://github.com/python-poetry/cleo.git\", branch = \"main\" }\n# Optional dependencies (installed by extras)\npendulum = { version = \"^2.1.2\", optional = true }\n\n# Dependency groups are supported for organizing your dependencies\n[tool.poetry.group.dev.dependencies]\npytest = \"^7.1.2\"\npytest-cov = \"^3.0\"\n\n# ...and can be installed only when explicitly requested\n[tool.poetry.group.docs]\noptional = true\n[tool.poetry.group.docs.dependencies]\nSphinx = \"^5.1.1\"\n\n# Python-style entrypoints and scripts are easily expressed\n[tool.poetry.scripts]\nmy-script = \"my_package:main\"\n```\n\n## Installation\n\nPoetry supports multiple installation methods, including a simple script found at [install.python-poetry.org]. For full\ninstallation instructions, including advanced usage of the script, alternate install methods, and CI best practices, see\nthe full [installation documentation].\n\n## Documentation\n\n[Documentation] for the current version of Poetry (as well as the development branch and recently out of support\nversions) is available from the [official website].\n\n## Contribute\n\nPoetry is a large, complex project always in need of contributors. For those new to the project, a list of\n[suggested issues] to work on in Poetry and poetry-core is available. The full [contributing documentation] also\nprovides helpful guidance.\n\n## Resources\n\n* [Releases][PyPI Releases]\n* [Official Website]\n* [Documentation]\n* [Issue Tracker]\n* [Discord]\n\n [PyPI]: https://pypi.org/project/poetry/\n [PyPI Releases]: https://pypi.org/project/poetry/#history\n [Official Website]: https://python-poetry.org\n [Documentation]: https://python-poetry.org/docs/\n [Issue Tracker]: https://github.com/python-poetry/poetry/issues\n [Suggested Issues]: https://github.com/python-poetry/poetry/contribute\n [Contributing Documentation]: https://python-poetry.org/docs/contributing\n [Discord]: https://discord.com/invite/awxPgve\n [install.python-poetry.org]: https://install.python-poetry.org\n [Installation Documentation]: https://python-poetry.org/docs/#installation\n\n## Related Projects\n\n* [poetry-core](https://github.com/python-poetry/poetry-core): PEP 517 build-system for Poetry projects, and\ndependency-free core functionality of the Poetry frontend\n* [poetry-plugin-export](https://github.com/python-poetry/poetry-plugin-export): Export Poetry projects/lock files to\nforeign formats like requirements.txt\n* [poetry-plugin-bundle](https://github.com/python-poetry/poetry-plugin-bundle): Install Poetry projects/lock files to\nexternal formats like virtual environments\n* [install.python-poetry.org](https://github.com/python-poetry/install.python-poetry.org): The official Poetry\ninstallation script\n* [website](https://github.com/python-poetry/website): The official Poetry website and blog\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python dependency management and packaging made easy.",
"version": "1.8.4",
"project_urls": {
"Changelog": "https://python-poetry.org/history/",
"Documentation": "https://python-poetry.org/docs",
"Homepage": "https://python-poetry.org/",
"Repository": "https://github.com/python-poetry/poetry"
},
"split_keywords": [
"packaging",
" dependency",
" poetry"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6293b73911fd5eb152cd42cb7aca0ecc23289d6a94da7a6699046acc46224db9",
"md5": "32e0be0ec06cbf8ecadccf74aa00290c",
"sha256": "1223bb6dfdbdfbebc6790796b9b7a88ea1f1f4679e709594f698499010ffb129"
},
"downloads": -1,
"filename": "poetry-1.8.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "32e0be0ec06cbf8ecadccf74aa00290c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 249920,
"upload_time": "2024-10-14T16:07:36",
"upload_time_iso_8601": "2024-10-14T16:07:36.263966Z",
"url": "https://files.pythonhosted.org/packages/62/93/b73911fd5eb152cd42cb7aca0ecc23289d6a94da7a6699046acc46224db9/poetry-1.8.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2984dbf6db6ecf3cbb2926c05a0b831bb03559c15b700d9836c8afc9022bcedb",
"md5": "0774b0d5d2dd5dde36537bd2b4b3b533",
"sha256": "5490f8da66d17eecd660e091281f8aaa5554381644540291817c249872c99202"
},
"downloads": -1,
"filename": "poetry-1.8.4.tar.gz",
"has_sig": false,
"md5_digest": "0774b0d5d2dd5dde36537bd2b4b3b533",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 1519163,
"upload_time": "2024-10-14T16:07:38",
"upload_time_iso_8601": "2024-10-14T16:07:38.269411Z",
"url": "https://files.pythonhosted.org/packages/29/84/dbf6db6ecf3cbb2926c05a0b831bb03559c15b700d9836c8afc9022bcedb/poetry-1.8.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-14 16:07:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "python-poetry",
"github_project": "poetry",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "poetry"
}