pyprojectsort 0.2.2

Formatter for pyproject.toml files

pyprojectsort

Formatter for pyproject.toml files.

This package enforces consistent formatting of pyproject.toml files, reducing merge request conflicts and saving time otherwise spent to format manually. It also contributes to a cleaner git history and more readable code; enhancing overall project organisation and maintainability. Experience a streamlined workflow, reduced errors, and improved code readability with pyprojectsort.

Features

• Alphabetically sorts pyproject.toml by:
  • section
  • section key
  • list value
• Reformats pyproject.toml to a standardised style
  • line per list value
  • double quotations
  • trailing commas
  • indentation
  • end of file newline

Installation

pyprojectsort is available via PyPI:

pip install pyprojectsort

Using pyprojectsort with pre-commit

To use as an automated git hook, add this to your .pre-commit-config.yaml:

- repo: https://github.com/kieran-ryan/pyprojectsort
  rev: v0.2.1
  hooks:
    - id: pyprojectsort

Examples

With the following pyproject.toml:

[tool.ruff]
ignore = ["G004",
"T201",
    "ANN"
]

[project]
name = 'pyprojectsort'

[tool.radon]
show_mi = true
exclude = "tests/*,venv/*"
total_average = true
show_complexity = true

[build-system]
build-backend = "flit.buildapi"
requires = ["flit"]

Run the package from within its directory:

pyprojectsort

The configuration will be reformatted as follows:

[build-system]
build-backend = "flit.buildapi"
requires = [
    "flit",
]

[project]
name = "pyprojectsort"

[tool.radon]
exclude = "tests/*,venv/*"
show_complexity = true
show_mi = true
total_average = true

[tool.ruff]
ignore = [
    "ANN",
    "G004",
    "T201",
]

The pyproject file path can alternatively be specified:

pyprojectsort ../pyproject.toml

Check formatting

The --check option can be used to determine whether your file would be reformatted.

pyprojectsort --check

If the file needs reformatting, the program exits with code 1. This is useful for pipeline integration as it prevents writing back changes so a clean repository is maintained for subsequent jobs.

License

pyprojectsort is licensed under the MIT License.