Skip to content

Refresh contributor documentation for the current client status - #30

Merged
woksin merged 3 commits into
mainfrom
docs/refresh-contributor-docs
Sep 25, 2026
Merged

woksin merged 3 commits into
mainfrom
docs/refresh-contributor-docs

Conversation

@woksin

@woksin woksin commented Sep 25, 2026

Copy link
Copy Markdown
Collaborator

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

  • A Current status table in the README covering the client API, PyPI availability, the generated contracts package, supported Python versions (3.10 to 3.14), and shared Chronicle documentation, each linked to the issue that tracks it.
  • A Check the kernel before writing client code section in the client development guide. It has a curl token check and a contracts-based Python probe that calls EnsureEventStore without and with a bearer token. Both were run against cratis/chronicle:16.38.2-development and print the output the guide shows.
  • Troubleshooting for the failures contributors are most likely to hit: blocked downloads of the contracts wheel, a wheel hash mismatch, port 35000 already in use, a kernel that is still starting, an untrusted self-signed certificate, and UNAUTHENTICATED calls.
  • The success signal for each required check in CONTRIBUTING.md, plus the Windows PowerShell equivalent of rm -rf dist.

Changed

  • The development setup now starts from git clone, notes that the install downloads the contracts wheel from GitHub release assets, and includes an import check that prints the package version.
  • The local kernel command pins cratis/chronicle:16.38.2-development, the version the contracts wheel is generated from, and binds only to 127.0.0.1. Compatibility between the 16.38.2 contracts and newer kernels, including latest-development, is unverified, and the guide now says so.
  • The TLS guidance names the development certificate's host names and states that the guide does not adopt the .NET client's accept-any-certificate default. How local-development relaxation is exposed remains an API decision for connection-string parsing (Parse and validate Chronicle connection strings #2); relaxed validation must never apply to non-local connections.
  • Getting started lists what works today and points readers who need a working client now to the .NET, TypeScript, Kotlin/Java, or Elixir clients.

Fixed

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
@woksin woksin added the no-release No package release required label Sep 25, 2026
@woksin
woksin enabled auto-merge September 25, 2026 13:57
@woksin
woksin merged commit 46b2ec2 into main Sep 25, 2026
8 of 9 checks passed
@woksin
woksin deleted the docs/refresh-contributor-docs branch September 25, 2026 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-release No package release required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant