docs: clarify graphik is not yet published to PyPI - #29
Merged
Conversation
The README's Installation section presented `pip install graphik` as already working, but the package has never been published (confirmed via `pip download graphik`, which finds no matching distribution). Point new users at a git-install until the first release is tagged. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Member
Author
|
Self-review rubric:
Repo-specific rubric:
Context: triage found zero open issues/PRs and a clean state everywhere else (version sources in sync, test coverage already comprehensive for the current public API). This installation-instructions gap was the one verifiable inaccuracy found in a full documentation sweep. drafted by Claude on behalf of Daniel Stephenson |
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.
Summary
pip install graphikas if it already worked, but the package has never been published to PyPI (pip download graphikfinds no matching distribution — confirmed against the live PyPI index).pip install git+https://...install path, while keeping the eventualpip install graphikinstruction for after the first release (per RELEASING.md).No source changes — documentation only.
Triage note
Repo had zero open issues and zero open PRs at the start of this cycle. A full triage sweep (README, RELEASING.md, pyproject.toml, LICENSE,
_version.py, CI workflows, test suite) found the version sources already in sync and test coverage already comprehensive for the current public API — the only verifiable drift found was this installation instruction. This cycle's entire (empty) backlog is therefore accounted for by this one finding; no issues were deferred.Test plan
python3 -m py_compile src/main/python/preponderous/graphik/graphik.py— succeedspython3 -m pytest -q— 25 passed (headless via conftest.py's SDL dummy drivers)pip download graphik --no-deps— confirms no PyPI distribution exists today, supporting the doc claimCloses #N(no tracking issue existed for this)This PR description was drafted during a Gardener session (Stephenson-Software/gardener).