Skip to content

Commit

Permalink
INSTALL.md: Mention pypi / pipx as install option
Browse files Browse the repository at this point in the history
Signed-off-by: David Linke <[email protected]>
  • Loading branch information
dalito committed Nov 30, 2024
1 parent 05c7dfb commit 16947d4
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
* [Installation via Package Manager](#installation-via-package-manager)
* [Detailed installation explanation for
packagers](#detailed-installation-explanation-for-packagers)
* [Installation as Python Package from
PyPI](#installation-as-python-package-from-pypi)
* [Installation via Makefile](#installation-via-makefile)
* [Notes for Windows Users](#notes-for-windows-users)

Expand Down Expand Up @@ -132,6 +134,17 @@ So, installation might look something like the following:

or you can use the provided Makefile, as noted below.

# Installation as Python Package from PyPI

`git-filter-repo` is also available as
[PyPI-package](https://pypi.org/project/git-filter-repo/).

Therefore, it can be installed with [pipx](https://pypa.github.io/pipx/)
or [uv tool](https://docs.astral.sh/uv/concepts/tools/).
Command example for pipx:

`pipx install git-filter-repo`

# Installation via Makefile

Installing should be doable by hand, but a Makefile is provided for those
Expand All @@ -146,6 +159,10 @@ you'll still need to do that yourself.

# Notes for Windows Users

git-filter-repo can be installed with multiple tools, such as
[pipx](https://pypa.github.io/pipx/) or a Windows-specific package manager
like Scoop (both of which were covered above).

Sadly, Windows sometimes makes things difficult. Common and historical issues:

* **Non-functional Python stub**: Windows apparently ships with a
Expand Down

0 comments on commit 16947d4

Please sign in to comment.