Repository navigation
Distribute via PEP 503 Pages index + themed API docs - #1
Merged
Merged
Conversation
- Replace the PyPI trusted-publishing workflow with pages.yml: build all
workspace packages, generate a PEP 503 'simple' install index + pdoc API
docs + a CU-themed landing, deploy to GitHub Pages.
- scripts/build_pages.py assembles the landing (one card per package),
copies dists, and writes the PEP 503 index. Install via:
pip install --extra-index-url \
https://cockroachlabs.github.io/cockroachdb-python-library/simple/ cockroachdb-core
- README: fix badges (PyPI->CI/Release/Python/License), correct sibling
org links felipeg/cockroachdb -> cockroachlabs, note the Pages index.
Pre-existing format drift surfaced once CI ran on cockroachlabs; ruff format 0.17 reformats the Python blocks in README.md. build_pages.py's embedded HTML/CSS template lines are exempted from E501 via a scripts/** per-file-ignore.
mypy 2.4 rejects a str-valued module variable used as a type. Define McpTransport with typing.TypeAlias over collections.abc.Callable instead of the forward-ref string, importing Callable/Mapping at runtime for the alias.
496 unit tests passed; the 30 failures/errors were all 'connection refused' to localhost:26257 (DDL compiler, dialect, alembic, integration suites). Provision a single-node CockroachDB (matches the Go/Java workflows).
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
1 participant
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.
Python has no GitHub Packages support, so (per decision) packages are distributed via a PEP 503 static index on this repo's GitHub Pages instead of PyPI.
uv buildall workspace packages → PEP 503/simple/index + copied dists,pdocAPI docs under/apidocs/, and a CU-themed landing matching the developer-libraries site. Deploys togh-pages.cockroachdbname is taken on PyPI).pip install --extra-index-url https://cockroachlabs.github.io/cockroachdb-python-library/simple/ cockroachdb-corescripts/build_pages.pyis locally tested.CI (ruff/mypy/pytest matrix) is unchanged. Release tag will be v0.1.1 (matches the package versions).