Skip to content

docs: install from GitHub, not PyPI - #42

Merged
RFingAdam merged 1 commit into
mainfrom
docs/install-from-github
Oct 16, 2026
Merged

RFingAdam merged 1 commit into
mainfrom
docs/install-from-github

Conversation

@RFingAdam

Copy link
Copy Markdown
Owner

Neither lineforge nor atlc3 is published on PyPI, but the docs told people to pip install them 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.

  • README, docs/quickstart.md, examples/03_mcp_claude_desktop.md: pip install "lineforge @ git+https://github.com/RFingAdam/lineforge.git", or a clone plus pip install -e for development and the GUI. Removes the claim that PyPI wheels exist.
  • MIGRATION.md and README: atlc3 was never on PyPI. Pin it by tag (atlc3 @ git+…@v1.1.0) instead of atlc3==1.1.0.
  • lineforge gui missing-extras hint and the [gui] comment in pyproject.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 docs mkdocs build --strict runs on this PR.

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/.
@RFingAdam

Copy link
Copy Markdown
Owner Author

Docs CI can't pick this up: docs.yml needs a [self-hosted, Linux, X64, haven] runner and this repo has none registered, so the job stays queued (every Docs run on main since 2026-09-10 was cancelled the same way). Ran the same mkdocs build --strict locally on this branch with the docs extras and lineforge installed: exit 0, no warnings, and the rendered quick start shows the GitHub install.

@RFingAdam
RFingAdam marked this pull request as ready for review October 16, 2026 15:00
@RFingAdam
RFingAdam merged commit 3e33c90 into main Oct 16, 2026
1 check passed
@RFingAdam
RFingAdam deleted the docs/install-from-github branch October 16, 2026 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant