Repository navigation
docs: add pipx/uv install instructions and externally-managed-environment troubleshooting - #1208
Merged
Merged
Conversation
…ment troubleshooting
Contributor
|
@xamelllion What does this mean? You have to have a GitHub account to create an issue, but otherwise I'm not aware of any restrictions. Your PR looks good so far. I'll finish my review soon. |
Contributor
|
/gcbrun |
Contributor
Author
|
My bad. Looks like my agent saw that message while browsing the issues page without being logged in. |
Contributor
|
@xamelllion All good, thanks for the update! |
stevemessick
approved these changes
Oct 2, 2026
stevemessick
left a comment
Contributor
There was a problem hiding this comment.
@rosbo Just wanted to check if you have any concerns about changing the recommended installation procedure.
rosbo
approved these changes
Oct 2, 2026
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.
Problem
The Installation section of
docs/README.mdonly suggestspip install kaggle.On many modern systems this fails with:
This is the expected behavior on distributions that follow
PEP 668 (e.g. Debian 12+, Ubuntu 23.04+,
Fedora, Arch, Homebrew Python). I ran into it on [OS, e.g. Ubuntu 24.04] with Python 3.12.
The docs currently don't mention this, so users following the instructions
literally get stuck.
Changes
Only
docs/README.mdis changed (Installation section):pipx install kaggle/uv tool install kaggleas the primarymethod: it works on all platforms and doesn't require users to manage
virtual environments.
pip install kaggleas an alternative.externally-managed-environment, pointingto pipx/uv first and mentioning
--break-system-packagesas a last resort,with a warning about the risks.
Command kaggle not foundnote into the same Troubleshooting block.No code changes.
Notes
README.mdlinks to this page for "Additional installation instructions",so I left it unchanged. Happy to update it too if you'd prefer.