Install Windows cotdata editable from clone (PyPI 0.1.0 is stale)#47
Merged
Conversation
The published PyPI release is far behind the repo but still numbered 0.1.0, so `pip install cotdata[norgate]` installs a build that lacks the producer CLI the rest of the docs use (--metadata, --require-final, databento flags) and fails with "unrecognized arguments". A producer following the guide verbatim ends up unable to run the documented workflow. - Lead Step 3 with a warning to install from the Step 2 clone, not PyPI. - Make both producer and consumer variants `-e` installs from the clone; note plain `pip install cotdata` becomes viable once a release lands. - Because the version wasn't bumped, both builds report 0.1.0, so verify by checking `cotdata-update --help` shows --metadata / --require-final rather than trusting the version string. Co-Authored-By: Claude Opus 4.8 <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.
What
Reworks Step 3 of the Windows setup guide to install cotdata editable from the cloned repo rather than from PyPI, for both producer and consumer.
Why
PyPI's published release is far behind this repo but still carries the version number
0.1.0. Sopip install "cotdata[norgate]"(what the guide told producers to run) installs a build that lacks the entire producer CLI the rest of the docs depend on:A producer following the guide verbatim ends up with a package that imports fine but can't run
--prices --metadata --require-final. Hit in practice while setting up a Windows producer.Changes
-ealso meansgit pullupdates it).-einstalls from the clone. Producer is listed first since that's the machine that needs the newer CLI. Noted that plainpip install cotdatabecomes fine for consumers once a current release is published.0.1.0, so the guide now says to confirm viacotdata-update --helpshowing--metadata/--require-final.Docs-only. Companion issue filed for the version bump + PyPI release that will let this revert to plain
pip install.🤖 Generated with Claude Code