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.
This PR changes the documentation to recommend installing with
pipx
rather thanpip
. There are two reasons why I think this is a useful change:pipx
installs packages into their own virtual environments, so their dependencies are completely isolated from the rest of the system. My understanding is that this is currently considered the best practice when it comes to installing packages that are meant to be used via the command-line (as opposed to those that are meant to be used as libraries), and I thinkgitlint
falls squarely in that category.pipx install
command isn't trivial, in that it requires the unusual--include-deps
flag. The reason is that thegitlint
package is a sort-of dummy package that pins dependency versions but doesn't directly provide the executable.pipx
notices this and complains about it, unless the above flag is given.If you don't want to change the recommendation from
pip
topipx
, feel free to close this PR. I just made it because it took me a little bit to figure out what was going on, and I thought it might save some other people the trouble.