Skip to content

docs: improve install discoverability and recommend pipx/uv#8

Merged
rahim-bhojani merged 1 commit intodremio:mainfrom
aniket-s-kulkarni:improve-install-discoverability
Mar 26, 2026
Merged

docs: improve install discoverability and recommend pipx/uv#8
rahim-bhojani merged 1 commit intodremio:mainfrom
aniket-s-kulkarni:improve-install-discoverability

Conversation

@aniket-s-kulkarni
Copy link
Copy Markdown
Collaborator

Summary

  • Lead install instructions with pipx/uv tool install instead of bare pip — avoids externally-managed-environment errors on modern macOS/Linux
  • Add explicit callout that dremio-client is an unrelated package (LLMs were installing it instead of dremio-cli)
  • Update PyPI description and keywords for better LLM/search discoverability

Context

A non-dev user asked Claude Code to "find the dremio CLI and install it." Claude found dremio-client (wrong package), hit the externally-managed-environment error, struggled with PATH, then hit missing deps in the wrong package. None of these are bugs in dremio-cli, but we can prevent the confusion with better docs and metadata.

Test plan

  • Verify README renders correctly on GitHub
  • Verify pipx install dremio-cli works on a clean macOS machine
  • Check PyPI description after next release shows the updated text

🤖 Generated with Claude Code

… pip

A non-dev user tried installing via Claude Code and hit three issues:
1. Claude found `dremio-client` (wrong package) instead of `dremio-cli`
2. `pip install` failed with `externally-managed-environment` on modern macOS
3. PATH wasn't configured for `~/.local/bin`

Changes:
- Lead install instructions with `pipx`/`uv tool install` (isolated by default)
- Add explicit note that `dremio-client` is a different, unrelated package
- Add tip explaining the `externally-managed-environment` error
- Update PyPI description to include install command for LLM discoverability
- Add `dremio-cloud` and `official` keywords to pyproject.toml

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown

@claude claude bot left a comment

Choose a reason for hiding this comment

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

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

@rahim-bhojani rahim-bhojani merged commit 85f20fa into dremio:main Mar 26, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants