docs: make the first Aiython demo work on a clean clone - #9
Merged
Merged
Conversation
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
A fresh clone could not run the no-key
--explaindemo: the checked-in config required a gitignored credential file that was absent. This is a launch-time conversion blocker.Changes
env_filereference from the checked-in config.api_key_envremains; runningaiython setupwith a key can create a private file locally.assets/readme/social-preview.png(1280×640, 45 KB) for upload via GitHub Settings → Social preview after merge. Merely storing the file in the repo does not activate the preview.Verification
uv run --locked aiython --explain examples/recipes/03_loop.pysucceeds without a credential and identifies two AI blocks.uv run --locked python -m unittest tests.test_config tests.test_cli_commands tests.test_ci_docs_only -q: 18 passed.git diff --check: clean.