docs(readme): fix SDK install (not on PyPI — install from source) - #42
Merged
Conversation
`pip install riskkernel` appeared twice in the README, but the package isn't published to PyPI (404), so anyone following the Python-SDK adoption path hit "No matching distribution". Point both spots at the from-source install (`pip install "git+https://github.com/prashar32/riskkernel.git#subdirectory=sdks/python"`), which works now that v0.1.1 fixed the wheel packaging (#32). Verified end-to-end: installs riskkernel 0.1.1 and imports. PyPI publish stays on the roadmap.
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.
Problem (launch-blocker)
The README tells people to
pip install riskkernel(twice — the "three ways to adopt" list and the quickstart tail), butriskkernelisn't on PyPI (https://pypi.org/pypi/riskkernel/json→ 404). Anyone following the #2 adoption path hitsNo matching distribution found for riskkernel. The name is unclaimed (404, not squatted), so it's a clean failure — but it's the kind of thing an HN/Reddit visitor trips on in the first 60 seconds.Fix
Point both spots at the from-source install, which works now that v0.1.1 fixed the wheel packaging (#32):
pip install "git+https://github.com/prashar32/riskkernel.git#subdirectory=sdks/python"Verified end-to-end in a clean venv: installs
riskkernel 0.1.1,import riskkernelresolvesRuntime/BudgetExceeded/ etc.PyPI publish stays on the roadmap (the name is free to claim when a publish workflow lands).
Note (separate, not changed here)
The quickstart curl uses model
claude-sonnet-4-5— worth confirming that id still resolves with a current key before launch, or swapping toclaude-haiku-4-5-20251001(what thecodebase-qademo uses). Left as-is; editorial call.