Skip to content

Install from the repository, not from PyPI - #14

Merged
richardmhope merged 1 commit into
mainfrom
docs/install-from-repo
Jul 28, 2026
Merged

Install from the repository, not from PyPI#14
richardmhope merged 1 commit into
mainfrom
docs/install-from-repo

Conversation

@richardmhope

Copy link
Copy Markdown
Collaborator

Every install line pointed at PyPI, where icebergsca does not exist and is not going to. They now point at a tagged git ref:

uv tool install git+https://github.com/IcebergAI/IcebergSCA@v0.1.0
pipx install git+https://github.com/IcebergAI/IcebergSCA.git@v0.1.0

# or without installing
uvx --from git+https://github.com/IcebergAI/IcebergSCA@v0.1.0 icebergsca scan .

The docs say so explicitly rather than just dropping the PyPI lines. A reader who assumes pip install icebergsca works is one squatted name away from installing someone else's code on the strength of our documentation.

The tag is pinned in every example, CI snippets included — without it you get whatever main is at that moment.

Files

  • README.md — Install section and the GitHub Actions snippet
  • website/docs/index.md — install block, plus a short "released from the repository, not from PyPI" note
  • website/docs/output.md — both CI snippets
  • src/icebergsca/.agents/skills/icebergsca/SKILL.md and references/ci-integration.md — the bundled skill carried the same instructions
  • website/zensical.toml — the comment where the PyPI social link used to be said "restore it with the first release", which is no longer the plan

Assumes v0.1.0 is tagged. Note the CHANGELOG still reads ## [Unreleased], and pyproject.toml is at 0.1.0 — worth cutting the tag and release before this merges, or the commands are accurate but not yet runnable.

Checked: zensical build --clean clean, ruff, mypy and 384 tests pass.

🤖 Generated with Claude Code

IcebergSCA is released from its GitHub repo and there is no icebergsca
package on PyPI, so every install line now points at a tagged git ref:

  uv tool install git+https://github.com/IcebergAI/IcebergSCA@v0.1.0
  uvx --from git+https://github.com/IcebergAI/IcebergSCA@v0.1.0 icebergsca ...

Says so explicitly rather than just omitting PyPI. A reader who assumes
`pip install icebergsca` works is one squatted name away from installing
someone else's code on the strength of our documentation.

The tag is pinned everywhere, CI snippets included.

Covers the README, the docs site (home page and CI page) and the bundled
agent skill, which carried the same instructions.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@richardmhope
richardmhope merged commit a368685 into main Jul 28, 2026
8 checks passed
@richardmhope
richardmhope deleted the docs/install-from-repo branch July 28, 2026 21:39
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