Skip to main content

Validate and format pyproject.toml files

Project description

pyproject-validate

CI/CD CI - Test CD - Build
Package PyPI - Version PyPI - Downloads PyPI - Python Version
Meta code style - black types - Mypy imports - isort License - MIT GitHub Sponsors

Validate and format pyproject.toml files.

Table of Contents

Installation

pip install pyproject-validate

Usage

usage: pyproject-validate [-h] [--fix] [--config CONFIG] [--version]

optional arguments:
  -h, --help       show this help message and exit
  --fix            whether to apply fixes for any encountered errors
  --config CONFIG  explicit path to the project config file
  --version        show program's version number and exit

Validators

Specs

Adhere to the data model defined by PEP 517 and PEP 621.

Naming

Ensure normalized project names.

Before:

[project]
name = "Foo.bAr"

After:

name = "foo-bar"

Dependencies

Ensure normalized and sorted PEP 508 dependency definitions.

Before:

[project]
dependencies = [
    "python-dateutil",
    "bAr.Baz[TLS]   >=1.2RC5",
    'Foo;python_version<"3.8"',
]

After:

dependencies = [
    "bar-baz[tls]>=1.2rc5",
    "foo; python_version < '3.8'",
    "python-dateutil",
]

License

pyproject-validate is distributed under the terms of the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyproject_validate-0.1.0.tar.gz (11.7 kB view hashes)

Uploaded Source

Built Distribution

pyproject_validate-0.1.0-py3-none-any.whl (8.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page