Repository navigation
docs: install from GitHub, not PyPI - #42
Merged
Merged
Conversation
Neither lineforge nor atlc3 is published on PyPI, but the README, quick start, MIGRATION.md and the MCP example told people to pip install them by name. Anyone could register those names and ship whatever they like to readers who follow the docs. Point every install at the GitHub repo instead, say plainly that a package under either name on PyPI is not this project, and pin atlc3 by its v1.1.0 tag. The lineforge gui missing-extras hint now says to install the extras from a clone, which the GUI needs for frontend/.
Owner
Author
|
Docs CI can't pick this up: |
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.
Neither
lineforgenoratlc3is published on PyPI, but the docs told people topip installthem by name. Anyone could register those names and ship code to readers who follow the docs (raised in #16).This points every install at the GitHub repo and says plainly that a package under either name on PyPI is not this project.
docs/quickstart.md,examples/03_mcp_claude_desktop.md:pip install "lineforge @ git+https://github.com/RFingAdam/lineforge.git", or a clone pluspip install -efor development and the GUI. Removes the claim that PyPI wheels exist.MIGRATION.mdand README: atlc3 was never on PyPI. Pin it by tag (atlc3 @ git+…@v1.1.0) instead ofatlc3==1.1.0.lineforge guimissing-extras hint and the[gui]comment inpyproject.toml: install the extras from a clone.Release-planning docs (
docs/plan.md,AUDIT.md,docs/release/) are unchanged; they describe a future release, not current availability.Checked: both documented commands in fresh Python 3.12 venvs. The lineforge install builds the Rust core and solves the quickstart microstrip to Z0 = 51.93 Ω. The atlc3 tag pin installs 1.1.0. The new CLI hint renders through Rich as
pip install -e '.[gui]'. The docsmkdocs build --strictruns on this PR.