docs(readme): update installation instructions #713
Conversation
Codecov Report
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. @@ Coverage Diff @@
## main #713 +/- ##
==========================================
- Coverage 92.33% 92.20% -0.13%
==========================================
Files 135 135
Lines 5831 5839 +8
==========================================
Hits 5384 5384
- Misses 447 455 +8
Flags with carried forward coverage won't be shown. Click here to find out more. |
README.md
Outdated
| Alternatively, you can use [pipx](https://pypa.github.io/pipx/) to install and run the application in an isolated environment: | ||
|
|
||
| ```shell | ||
| $ pipx install ggshield |
There was a problem hiding this comment.
I would go even further and recommend pipx first. It's easier to maintain and works in externally managed environments where pip install does not (even with --user, I was curious and just checked)
| @@ -76,7 +82,7 @@ The package should run on MacOS, Linux and Windows. | |||
| To update `ggshield` you can add the option `-U/--upgrade` to the pip install command. | |||
|
|
|||
| ```shell | |||
| $ pip install -U ggshield | |||
| $ pip install --user -U ggshield | |||
There was a problem hiding this comment.
If we explain how to install with pipx then we must also explain how to upgrade with it here.
| @@ -0,0 +1,5 @@ | |||
| ### Changed | |||
There was a problem hiding this comment.
I don't think this needs to be in the changelog: the target audience for release notes are people who already have the app installed, they don't really care about how to do it :)
README.md
Outdated
|
|
||
| ### Installing | ||
|
|
||
| The recommended way to install `ggshield`` is to use [pipx](https://pypa.github.io/pipx/), which will install it an isolated environment: |
There was a problem hiding this comment.
| The recommended way to install `ggshield`` is to use [pipx](https://pypa.github.io/pipx/), which will install it an isolated environment: | |
| The recommended way to install `ggshield` is to use [pipx](https://pypa.github.io/pipx/), which will install it an isolated environment: |
README.md
Outdated
| $ pipx install ggshield | ||
| ``` | ||
|
|
||
| Alternatively, you can install with pip as an user package. This will not work if your Python installation is declared as externally managed (for example if using the system Python on some operating systems): |
There was a problem hiding this comment.
| Alternatively, you can install with pip as an user package. This will not work if your Python installation is declared as externally managed (for example if using the system Python on some operating systems): | |
| Alternatively, you can install with pip as a user package. This will not work if your Python installation is declared as externally managed (for example when using the system Python on operating systems like Debian 12): |
corenting
force-pushed
the
cgarcia/-/update-readme
branch
from
a48281f to
1dfd803
Compare
Thanks for the review! I squashed the PR & rebased on the latest main. |
--userto preventinstalling system-wide. It's not recommended to install system wide and may not work anyway on OS where the system Python is marked as externally managed (see PEP 668. It's the case for Debian 12 for example.