Refresh contributor documentation for the current client status - #30
Merged
Merged
Conversation
cratis ai update reported no content changes beyond the recorded source revision.
State that no client API or PyPI package exists, how the pinned contracts wheel is installed, supported Python versions, and the success signal for each required check.
- Correct the contracts distribution status after the PyPI publishing issues closed as not planned - Pin the development kernel to 16.38.2 and bind it to loopback - Describe TLS validation boundaries and link Chronicle's client contract pages - Add a token check, a contracts-based probe, troubleshooting, and next steps
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Contributor documentation now matches where Chronicle.Python stands today: no client API yet, no PyPI package, and a development setup you can reproduce from a source checkout.
Added
curltoken check and a contracts-based Python probe that callsEnsureEventStorewithout and with a bearer token. Both were run againstcratis/chronicle:16.38.2-developmentand print the output the guide shows.UNAUTHENTICATEDcalls.rm -rf dist.Changed
git clone, notes that the install downloads the contracts wheel from GitHub release assets, and includes an import check that prints the package version.cratis/chronicle:16.38.2-development, the version the contracts wheel is generated from, and binds only to127.0.0.1. Compatibility between the 16.38.2 contracts and newer kernels, includinglatest-development, is unverified, and the guide now says so.Fixed