Repository navigation
docs: refresh README (PyPI page) for the current SDK - #51
Merged
Merged
Conversation
The README is the PyPI project page. Rewrite it for 0.4.x: building blocks (tools, resources, prompts, guards, auth, caching, rate limits, tasks, events, health), env precedence, templates, clients. tests/test_readme_examples.py compiles every python block, checks every nitrostack import exists, and runs the Quick Start and Building Blocks examples through the testing harness so the page can't drift. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Why
PyPI shows the README, and it described an older SDK.
What
.envsince 0.4.1), env table, and a Building Blocks section (tools, resources/prompts, pipeline, auth, caching/rate limits, tasks, events/health), plus client setup.pyproject.toml:[project.urls](Homepage, Documentation, Repository, Issues) for the PyPI sidebar.tests/test_readme_examples.py: every python block compiles, everynitrostackimport exists, and the Quick Start / Building Blocks examples run throughNitroTestingModule. README drift fails CI.Notes
@cacheon a tool method fails withunhashable type(Pydantic input). The README puts@cacheon a service method instead.Test
uv build+twine check --strictpass; metadata has the Project-URL entries.🤖 Generated with Claude Code