Community Badge For any projects using Poetry, you may add its official badge somewhere prominent like the README. Markdown [](https://python-poetry.org/) reStructuredText .. image:: https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json :alt: Poetry :target: https://python-poetry.org/

Commands You’ve already learned how to use the command-line interface to do some things. This chapter documents all the available commands. To get help from the command-line, simply call poetry to see the complete list of commands, then --help combined with any of those can give you more information. Global Options --verbose (-v|vv|vvv): Increase the verbosity of messages: “-v” for normal output, “-vv” for more verbose output and “-vvv” for debug. --help (-h) : Display help information. --quiet (-q) : Do not output any message. --ansi: Force ANSI output. --no-ansi: Disable ANSI output. --version (-V): Display this application version. --no-interaction (-n): Do not ask any interactive question. --no-plugins: Disables plugins. --no-cache: Disables Poetry source caches. --directory=DIRECTORY (-C): The working directory for the Poetry command (defaults to the current working directory). All command-line arguments will be resolved relative to the given directory. --project=PROJECT (-P): Specify another path as the project root. All command-line arguments will be resolved relative to the current working directory or directory specified using --directory option if used. about The about command displays global information about Poetry, including the current version and version of poetry-core.

FAQ Why is the dependency resolution process slow? While the dependency resolver at the heart of Poetry is highly optimized and should be fast enough for most cases, with certain sets of dependencies, it can take time to find a valid solution. This is due to the fact that not all libraries on PyPI have properly declared their metadata and, as such, they are not available via the PyPI JSON API. At this point, Poetry has no choice but to download the packages and inspect them to get the necessary information. This is an expensive operation, both in bandwidth and time, which is why it seems this is a long process.

FAQ Why is the dependency resolution process slow? While the dependency resolver at the heart of Poetry is highly optimized and should be fast enough for most cases, with certain sets of dependencies it can take time to find a valid solution. This is due to the fact that not all libraries on PyPI have properly declared their metadata and, as such, they are not available via the PyPI JSON API. At this point, Poetry has no choice but to download the packages and inspect them to get the necessary information. This is an expensive operation, both in bandwidth and time, which is why it seems this is a long process.

Building Extension Modules Warning While this feature has been around since almost the beginning of the Poetry project and has needed minimal changes, it is still considered unstable. You can participate in the discussions about stabilizing this feature here. And as always, your contributions towards the goal of improving this feature are also welcome. Poetry allows a project developer to introduce support for, build and distribute native extensions within their project. In order to achieve this, at the highest level, the following steps are required.

pre-commit hooks pre-commit is a framework for building and running git hooks. See the official documentation for more information: pre-commit.com This document provides a list of available pre-commit hooks provided by Poetry. Note If you specify the args: for a hook in your .pre-commit-config.yaml, the defaults are overwritten. You must fully specify all arguments for your hook if you make use of args:. Note If the pyproject.toml file is not in the root directory, you can specify args: ["-C", "./subdirectory"]. poetry-check The poetry-check hook calls the poetry check command to make sure the poetry configuration does not get committed in a broken state.

Commands You’ve already learned how to use the command-line interface to do some things. This chapter documents all the available commands. To get help from the command-line, simply call poetry to see the complete list of commands, then --help combined with any of those can give you more information. Global options --verbose (-v|vv|vvv): Increase the verbosity of messages: “-v” for normal output, “-vv” for more verbose output and “-vvv” for debug. --help (-h) : Display help information. --quiet (-q) : Do not output any message. --ansi: Force ANSI output. --no-ansi: Disable ANSI output. --version (-V): Display this application version. --no-interaction (-n): Do not ask any interactive question. --no-plugins: Disables plugins. --no-cache: Disables Poetry source caches. --directory=DIRECTORY (-C): The working directory for the Poetry command (defaults to the current working directory). new This command will help you kickstart your new Python project by creating a directory structure suitable for most projects.

Introduction 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. Poetry offers a lockfile to ensure repeatable installs, and can build your project for distribution. System requirements Poetry requires Python 3.9+. It is multi-platform and the goal is to make it work equally well on Linux, macOS and Windows.

Libraries This chapter will tell you how to make your library installable through Poetry. Versioning Poetry requires PEP 440-compliant versions for all projects. While Poetry does not enforce any release convention, it used to encourage the use of semantic versioning within the scope of PEP 440 and supports version constraints that are especially suitable for semver. Note As an example, 1.0.0-hotfix.1 is not compatible with PEP 440. You can instead choose to use 1.0.0-post1 or 1.0.0.post1. Lock file For your library, you may commit the poetry.lock file if you want to. This can help your team to always test against the same dependency versions. However, this lock file will not have any effect on other projects that depend on it. It only has an effect on the main project.

Configuration Poetry can be configured via the config command (see more about its usage here) or directly in the config.toml file that will be automatically created when you first run that command. This file can typically be found in one of the following directories: macOS: ~/Library/Application Support/pypoetry Windows: %APPDATA%\pypoetry For Unix, we follow the XDG spec and support $XDG_CONFIG_HOME. That means, by default ~/.config/pypoetry. Local configuration Poetry also provides the ability to have settings that are specific to a project by passing the --local option to the config command.