Skip to content

Commit

Permalink
README: more small cleanup
Browse files Browse the repository at this point in the history
Signed-off-by: William Woodruff <william@trailofbits.com>
  • Loading branch information
woodruffw committed May 8, 2024
1 parent 0a7917f commit 79abb8a
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@

A library to convert between Sigstore Bundles and [PEP 740] Attestation objects

[PEP 740]: https://peps.python.org/pep-0740/

## Installation

```bash
Expand All @@ -20,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.

Expand Down Expand Up @@ -50,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
Expand All @@ -77,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

0 comments on commit 79abb8a

Please sign in to comment.