poetry-plugin-sort

Poetry Plugin: Dependencies sorting

This package is a plugin that sort dependencies alphabetically in pyproject.toml after running poetry init and poetry add. Since Introduce dependency sorting #3996 pull request still open this plugin is a workaround for !312 issue.

Installation

Just use poetry self add command to add this plugin.

poetry self add poetry-plugin-sort

If you used pipx to install Poetry, add the plugin via pipx inject command.

pipx inject poetry poetry-plugin-sort

And if you installed Poetry using pip, you can install the plugin the same way.

pip install poetry poetry-plugin-sort

Usage

The plugin sorts dependencies each time when you change dependencies via the poetry init and poetry add commands.

To sort dependencies without making changes to the dependencies list, the plugin provides a sort command.

poetry sort

Available options

• --check: Checks if dependencies are sorted and exits with a non-zero status code when it doesn't.

Configurations

The following configuration can be set in [tool.poetry-sort] section of the pyproject.toml file or as system-wide environment variables:

• enabled \ POETRY_SORT_ENABLED: Enable or disable sorting after invoking poetry init and poetry add commands. Default: True.
• move-optionals-to-bottom \ POETRY_SORT_MOVE_OPTIONALS_TO_BOTTOM: Move optional packages to the bottom. Default: False.