Document installing FlowRoute from PyPI - #2
Merged
Merged
Conversation
The package is published, so `pip install flowroute` replaces the editable install as the default path. Extras become `"flowroute[api]"` and `"flowroute[hf]"`; `[dev]` stays editable because it only makes sense from a clone. The wheel ships the flowroute package alone — no examples/, configs/, or training/. Every getting-started command previously assumed a checkout, so a reader following the new install path hit FileNotFoundError on examples/workflows.yaml at the first command. The quickstart now fetches the demo catalog from the v0.2.0 tag, and the paths that genuinely need a checkout (fixture evaluation, training scripts, docs build) say so. Add a PyPI version badge and an install block on the documentation home. Co-Authored-By: Claude Opus 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
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.
FlowRoute 0.2.0 is live at pypi.org/project/flowroute, so the docs should stop telling readers to install from a checkout.
The bug this fixes
The wheel ships the
flowroutepackage and nothing else — noexamples/,configs/, ortraining/. Every getting-started command assumed a clone, so a reader who followedpip install flowroutehit this on the first command in the quickstart:The quickstart now fetches the demo catalog from the
v0.2.0tag, and the paths that genuinely need a checkout — fixture evaluation, training scripts, docs build,[dev]— say so explicitly rather than failing silently.Changes
[api]/[hf]extras use the published name; fixture-evaluation and training blocks state the clone requirement.installation.md— PyPI is the default; a new From source section covers the clone workflow;Verify the installno longer runsPYTHONPATH=src python -m unittest, which only worked in a checkout.quickstart.md— self-contained against a PyPI-only install.index.md— install block on the docs home.cli.md,http-api.md— published extras.pip install -e ".[dev]"deliberately stays editable: it only makes sense from a clone.Verified against the published package
Every documented command was run against a venv installed from the real index, not a local build:
pip install flowroutepip checkcleanpip install "flowroute[api]"curl -O .../v0.2.0/examples/workflows.yamlflowroute route --catalog workflows.yamlROUTE→orders.get_status,ACCEPTED_LOW_RISKflowroute --helppython -c "import flowroute; print(flowroute.__version__)"0.2.0mkdocs build --strict#from-sourceanchor resolvesThe quickstart catalog was also exercised for
CLARIFY(MISSING_REQUIRED_INPUT) andLLM_REQUIRED(OPEN_ENDED_REASONING) to confirm it demonstrates all three outcomes.🤖 Generated with Claude Code