Validation library and CLI tool for checking on 'pyproject.toml' files using JSON Schema
Project description
validate-pyproject
Automated checks on pyproject.toml powered by JSON Schema definitions
Description
With the approval of PEP 517 and PEP 518, the Python community shifted towards a strong focus on standardisation for packaging software, which allows more freedom when choosing tools during development and make sure packages created using different technologies can interoperate without the need for custom installation procedures.
This shift became even more clear when PEP 621 was also approved, as a standardised way of specifying project metadata and dependencies.
validate-pyproject was born in this context, with the mission of validating pyproject.toml files, and make sure they are compliant with the standards and PEPs. Behind the scenes, validate-pyproject relies on JSON Schema files, which, in turn, are also a standardised way of checking if a given data structure complies with a certain specification.
Usage
The easiest way of using validate-pyproject is via CLI. To get started, you need to install the package, which can be easily done using pipx:
$ pipx install 'validate-pyproject[all]'Now you can use validate-pyproject as a command line tool:
# in you terminal
$ validate-pyproject --help
$ validate-pyproject path/to/your/pyproject.tomlYou can also use validate-pyproject in your Python scripts or projects:
# in your python code
from validate_pyproject import api, errors
# let's assume that you have access to a `loads` function
# responsible for parsing a string representing the TOML file
# (you can check the `toml` or `tomli` projects for that)
pyproject_as_dict = loads(pyproject_toml_str)
# now we can use validate-pyproject
validator = api.Validator()
try:
validator(pyproject_as_dict)
except errors.ValidationError as ex:
print(f"Invalid Document: {ex.message}")To do so, don’t forget to add it to your virtual environment or specify it as a project or library dependency.
More details about validate-pyproject and its Python API can be found in our docs, which includes a description of the used JSON schemas, instructions for using it in a pre-compiled way and information about extending the validation with your own plugins.
pre-commit
validate-pyproject can be installed as a pre-commit hook:
---
repos:
- repo: https://github.com/abravalheri/validate-pyproject
rev: main
hooks:
- id: validate-pyprojectBy default, this pre-commit hook will only validate the pyproject.toml file at the root of the project repository. You can customize that by defining a custom regular expression pattern using the files parameter.
You can also use pre-commit autoupdate to update to the latest stable version of validate-pyproject (recommended).
Note
This project and its sister project ini2toml were initially created in the context of PyScaffold, with the purpose of helping migrating existing projects to PEP 621-style configuration when it is made available on setuptools. For details and usage information on PyScaffold see https://pyscaffold.org/.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file validate-pyproject-0.12.tar.gz.
File metadata
- Download URL: validate-pyproject-0.12.tar.gz
- Upload date:
- Size: 88.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1a87b19b0db585e70c2053f8e8eaa586f1fae342b2387c8dc92b4ce776a64508 |
|
| MD5 | 59722be898c64b999e49030f1e8e7b46 |
|
| BLAKE2b-256 | a8cb563d7de74881bb9e9e4d22c6d721bd286097efd74f3879791d586a2b134d |
File details
Details for the file validate_pyproject-0.12-py3-none-any.whl.
File metadata
- Download URL: validate_pyproject-0.12-py3-none-any.whl
- Upload date:
- Size: 43.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 517fb56c32f7d3c139678dd897d7bed7f83c157ef637e5969ad88c4ebc38dc89 |
|
| MD5 | d4eae9303929fd6fe30bdf3aefd19a32 |
|
| BLAKE2b-256 | 82721e3eb0c13561036c506b482a688156e46f31f21550718ae4a7645ecc6a7d |
