sigstore-python icon indicating copy to clipboard operation
sigstore-python copied to clipboard

Finalize importable `sigstore` API

Open tetsuo-cpp opened this issue 3 years ago • 3 comments

Once we've written the Fulcio and Rekor clients, we should be fill out the importable API. The API should roughly line up with the subcommands that cosign supports.

The CLI itself (which we'll implement in #3) will be a thin wrapper that wires the argparse flags to the API. So the meat of the CLI logic will be covered in this task.

I expect that we'll separate this into multiple issues when we begin working on it.

tetsuo-cpp avatar Mar 07 '22 10:03 tetsuo-cpp

This is a great article that explains what cosign is doing under the hood: https://martinheinz.dev/blog/56

tetsuo-cpp avatar Mar 07 '22 11:03 tetsuo-cpp

Changed this to 'finalize' instead of implement and moved it to the 1.0 milestone.

di avatar Apr 28 '22 17:04 di

xref #250 for some changes that will happen to these APIs before stabilization.

woodruffw avatar Oct 21 '22 19:10 woodruffw

For visibility: #299 is going to refactor the verification API per #250, which will get us much closer to a stabilize-able public API.

woodruffw avatar Nov 14 '22 20:11 woodruffw

cc @mayaCostantini: the API in #299 isn't public yet, but it's much closer to what the final stable API will look like, if you'd like to experiment with it!

woodruffw avatar Nov 21 '22 17:11 woodruffw

Thanks a lot @woodruffw !

mayaCostantini avatar Nov 21 '22 20:11 mayaCostantini

I'm going to make a separate issue to begin generating API docs like we do for pip-audit.

tetsuo-cpp avatar Jan 05 '23 00:01 tetsuo-cpp

@mayaCostantini we've just cut 0.10.0, which has the first official iteration of the stable API 🙂

The docs are here: https://sigstore.github.io/sigstore-python/

woodruffw avatar Jan 09 '23 20:01 woodruffw

Amazing, thanks @woodruffw !

mayaCostantini avatar Jan 10 '23 08:01 mayaCostantini

No problem! FYI there will be a handful of small changes before 1.0, but we'll make sure they're all tracked in the CHANGELOG.

woodruffw avatar Jan 10 '23 17:01 woodruffw