poetry-sort 1.2.0

Alphabetically sort your Poetry dependencies

poetry-sort

poetry-sort is a Poetry plugin that alphabetically sorts the dependencies in your pyproject.toml file.

Installation

poetry self add poetry-sort

Usage

poetry sort

poetry sort supports the --with, --without, and --only options, which function identically to poetry install. For full usage information, run poetry sort --help.

poetry-sort runs automatically whenever you run poetry add or poetry init and will sort only the dependency groups that were modified by the command.

Configuration

poetry-sort can be configured either on a per-project basis in pyproject.toml or globally in your Poetry config.toml file. Either way, configuration options are placed inside the tool.sort.config key.

[tool.sort.config]
auto = true
case-sensitive = false
sort-python = false
format = true

Settings defined in pyroject.toml will override settings defined in config.toml.

The following options are available:

• auto (bool, default: true): Whether or not to automatically sort dependencies when running poetry add or poetry init. poetry sort can always be run manually, regardless of this setting.

• case-sensitive (bool, default: false): Whether to take case into account when sorting.

• sort-python (bool, default: false): Whether to also sort the python dependency. If false, the python dependency will be placed at the top of tool.poetry.dependencies; if true, it will be sorted alphebetically with everything else.

• format (bool, default: true): Whether to apply some basic formatting to pyproject.toml after sorting. If true, poetry-sort will take all occurences of three or more consecutive newlines in pyproject.toml and replace them with two newlines. If false, poetry-sort will not modify pyproject.toml beyond just sorting your dependencies.

License

poetry-sort is licensed udner the MIT License.