Skip to content

docs(readme): pip install codebase-index from PyPI#20

Merged
denfry merged 1 commit into
mainfrom
docs/readme-pypi-install
Jun 24, 2026
Merged

docs(readme): pip install codebase-index from PyPI#20
denfry merged 1 commit into
mainfrom
docs/readme-pypi-install

Conversation

@denfry

@denfry denfry commented Jun 24, 2026

Copy link
Copy Markdown
Owner

Now that v1.6.0 is on PyPI, the README leads with pip install codebase-index.

  • Shortest-path + "How do I install" snippets → pip install codebase-index.
  • Install options: new Option 1: Install from PyPI (recommended) (pip/pipx); the git+tag installs become Option 2/3 for pinning to an exact version or an unreleased commit.
  • Python-version pipx troubleshooting commands switched to the PyPI name.
  • Project Status + Distribution roadmap updated (PyPI shipped; uvx/Homebrew still planned).

Docs-only; no code change.

🤖 Generated with Claude Code

PyPI is live as of 1.6.0, so make `pip install codebase-index` the primary
install (Option 1); keep the pinned git+tag installs as alternatives for
reproducible/unreleased installs. Update Project Status + distribution roadmap.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@denfry denfry merged commit d8f9b06 into main Jun 24, 2026
10 checks passed
@denfry denfry deleted the docs/readme-pypi-install branch June 24, 2026 07:26

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 3a4d564ce3

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
Comment on lines +127 to +131
For most users, install the package from PyPI and run `init` inside the
repository you want to index:

```bash
pip install "codebase-index @ git+https://github.com/denfry/codebase-index.git@v1.6.0"
pip install codebase-index # or: pipx install codebase-index

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Update the linked installation guide too

This makes PyPI the primary install path in the README, but the linked full guide still tells users the opposite (docs/INSTALLATION.md:5-7 says the package is not on PyPI, and docs/INSTALLATION.md:92-96 keeps PyPI/pipx in the future roadmap). Users who follow the README’s install section to the installation guide will get contradictory commands, so the guide should be updated in the same change or this primary recommendation should remain on the GitHub-tag path.

Useful? React with 👍 / 👎.

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