Update README install instructions to use pipx#877
Update README install instructions to use pipx#877CodeBySayak wants to merge 3 commits intolinode:devfrom
Conversation
Update README install instructions to use pipx
CodeBySayak
requested review from
mawilk90 and
mgwoj
and removed request for
a team
There was a problem hiding this comment.
Pull request overview
This PR updates the README installation guidance to recommend installing linode-cli via pipx instead of pip3, aligning with modern Python packaging practices (e.g., PEP 668 concerns around system-managed environments).
Changes:
- Switched install command from
pip3 install linode-clitopipx install linode-cli. - Added an upgrade command (
pipx upgrade linode-cli) and rationale for usingpipx.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| To upgrade: | ||
| ``` | ||
| pipx upgrade linode-cli | ||
| We recommend using `pipx` to install `linode-cli`, as it installs Python CLI tools in isolated environments and avoids conflicts with system-managed Python packages (PEP 668). | ||
| Visit the [Wiki](../../wiki/Installation) for more information. |
There was a problem hiding this comment.
The new "To upgrade" snippet opens a fenced code block but never closes it, which causes the recommendation text and the following "Visit the Wiki" line to render as code. Close the fence after the upgrade command, and consider using ```bash for consistency with the install snippet, with the explanatory sentence as a normal paragraph outside the code block.
Co-authored-by: Michal Wojcik <32574975+mgwoj@users.noreply.github.com>
Summary
This PR updates the installation instructions in README.md to recommend
pipxinstead ofpip3.Changes
pip3 install linode-cliwithpipx install linode-clipipx upgrade linode-clicommandWhy
Using pipx avoids conflicts with system-managed Python environments and follows modern Python best practices.
How to Test
pipx