diff --git a/README.md b/README.md index 3096327..1c0f746 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![Packaging status](https://repology.org/badge/tiny-repos/python:pypi-attestation-models.svg)](https://repology.org/project/python:pypi-attestation-models/versions) -A library to convert between Sigstore Bundles and PEP-740 Attestation objects +A library to convert between Sigstore Bundles and [PEP 740] Attestation objects ## Installation @@ -18,8 +18,8 @@ python -m pip install pypi-attestation-models See the full API documentation [here]. - ### Signing and verification + Use these APIs to create a PEP 740-compliant `Attestation` object by signing a Python artifact (i.e: sdist or wheel files), and to verify an `Attestation` object against a Python artifact. @@ -48,7 +48,6 @@ attestation = Attestation.model_validate_json(attestation_path.read_bytes()) verifier = Verifier.production() policy = policy.Identity(identity="example@gmail.com", issuer="https://accounts.google.com") attestation.verify(verifier, policy, attestation_path) - ``` ### Low-level model conversions @@ -75,4 +74,6 @@ bundle = pypi_to_sigstore(attestation) print(bundle.to_json()) ``` +[PEP 740]: https://peps.python.org/pep-0740/ + [here]: https://trailofbits.github.io/pypi-attestation-models