Add inline --holdings so the quickstart needs no files (v0.2.0)#27
Merged
Conversation
Launch-blocker fix: the README quickstart used --bucket examples/... which only exist in the repo, so `pip install`-ed users hit FileNotFoundError. Now `divvy compare --holdings "SCHD=45,DGRO=25,VYM=15,SDY=15"` defines a bucket inline (weights auto-normalized, repeatable), so the quickstart runs from anywhere with zero files. --bucket still works for file-based. README updated to lead with the file-less path. Co-Authored-By: Claude Opus 4.8 <[email protected]>
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.
Launch-blocker fix found by testing the real
pip installnew-user path.The bug
The README quickstart used
--bucket examples/buckets/*.yaml, but those files ship only in the repo — apip install divvy-backtestuser running the quickstart gotFileNotFoundError: examples/buckets/dividend_etf_core.yaml. Worst possible first impression for Reddit/HN visitors.The fix
New
--holdings "SCHD=45,DGRO=25,VYM=15,SDY=15"flag defines a bucket inline (weights auto-normalized, repeatable, uppercased). The quickstart now runs from any directory with zero files.--bucket <file.yaml>still works.README updated to lead with the file-less
pip install+--holdingspath. Version bumped to 0.2.0.Checklist