Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Recommend installing with pipx #530

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kalekundert
Copy link

This PR changes the documentation to recommend installing with pipx rather than pip. 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 think gitlint falls squarely in that category.
  • The pipx install command isn't trivial, in that it requires the unusual --include-deps flag. The reason is that the gitlint 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 to pipx, 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.

@coveralls
Copy link

Coverage Status

coverage: 99.633%. remained the same when pulling 02d42aa on kalekundert:docs-pipx into 4d91197 on jorisroovers:main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants