sigstore: flatten models into sigstore.models (#990)

* sigstore: flatten models into sigstore.models Signed-off-by: William Woodruff <[email protected]> * CHANGELOG: record Signed-off-by: William Woodruff <[email protected]> --------- Signed-off-by: William Woodruff <[email protected]>
sigstore · May 2, 2024 · e043849 · e043849
1 parent 9cc8cb1
commit e043849
Show file tree

Hide file tree

Showing 15 changed files with 350 additions and 390 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -31,10 +31,10 @@ All versions prior to 0.9.0 are untracked.
 ### Removed
 
 * **BREAKING API CHANGE**: `SigningResult` has been removed.
-  The public signing APIs now return `sigstore.verify.models.Bundle`.
+  The public signing APIs now return `sigstore.models.Bundle`.
 
 * **BREAKING API CHANGE**: `VerificationMaterials` has been removed.
-  The public verification APIs now accept `sigstore.verify.models.Bundle`.
+  The public verification APIs now accept `sigstore.models.Bundle`.
 
 * **BREAKING API CHANGE**: `Signer.sign(...)` has been removed. Use
   either `sign_artifact(...)` or `sign_dsse(...)`, depending on whether
@@ -55,7 +55,7 @@ All versions prior to 0.9.0 are untracked.
   a `Hashed` parameter to convey the digest used for Rekor entry lookup
   ([#904](https://github.com/sigstore/sigstore-python/pull/904))
 
-* **BREAKING API CHANGE**: `Verifier.verify(...)` now takes a `sigstore.verify.models.Bundle`,
+* **BREAKING API CHANGE**: `Verifier.verify(...)` now takes a `sigstore.models.Bundle`,
   instead of a `VerificationMaterials` ([#937](https://github.com/sigstore/sigstore-python/pull/937))
 
 * sigstore-python now requires inclusion proofs in all signing and verification
@@ -74,6 +74,9 @@ All versions prior to 0.9.0 are untracked.
   an inclusion proof. Passing `--offline` with detached materials will cause
   an error ([#937](https://github.com/sigstore/sigstore-python/pull/937))
 
+* API: `sigstore.transparency` has been removed, and its pre-existing APIs
+  have been re-homed under `sigstore.models`
+  ([#990](https://github.com/sigstore/sigstore-python/pull/990))
 
 ## [2.1.5]
 

diff --git a/sigstore/_cli.py b/sigstore/_cli.py
@@ -41,6 +41,7 @@
 from sigstore._utils import sha256_digest
 from sigstore.errors import Error, VerificationError
 from sigstore.hashes import Hashed
+from sigstore.models import Bundle
 from sigstore.oidc import (
     DEFAULT_OAUTH_ISSUER_URL,
     STAGING_OAUTH_ISSUER_URL,
@@ -54,7 +55,6 @@
     Verifier,
     policy,
 )
-from sigstore.verify.models import Bundle
 
 logging.basicConfig(format="%(message)s", datefmt="[%X]", handlers=[RichHandler()])
 _logger = logging.getLogger(__name__)

diff --git a/sigstore/_internal/merkle.py b/sigstore/_internal/merkle.py
@@ -33,7 +33,7 @@
 from sigstore.errors import VerificationError
 
 if typing.TYPE_CHECKING:
-    from sigstore.transparency import LogEntry
+    from sigstore.models import LogEntry
 
 
 _LEAF_HASH_PREFIX = 0

diff --git a/sigstore/_internal/rekor/__init__.py b/sigstore/_internal/rekor/__init__.py
@@ -24,12 +24,7 @@
 from sigstore._utils import base64_encode_pem_cert
 from sigstore.hashes import Hashed
 
-from .checkpoint import SignedCheckpoint
-from .client import RekorClient
-
 __all__ = [
-    "RekorClient",
-    "SignedCheckpoint",
     "_hashedrekord_from_parts",
 ]
 

diff --git a/sigstore/_internal/rekor/checkpoint.py b/sigstore/_internal/rekor/checkpoint.py
@@ -32,7 +32,7 @@
 from sigstore.errors import VerificationError
 
 if typing.TYPE_CHECKING:
-    from sigstore.transparency import LogEntry
+    from sigstore.models import LogEntry
 
 
 @dataclass(frozen=True)

diff --git a/sigstore/_internal/rekor/client.py b/sigstore/_internal/rekor/client.py
@@ -28,7 +28,7 @@
 import rekor_types
 import requests
 
-from sigstore.transparency import LogEntry
+from sigstore.models import LogEntry
 
 _logger = logging.getLogger(__name__)