Skip to content

Commit 34295ef

Browse files
committedNov 30, 2024·
Merge branch 'dl/pipx'
Signed-off-by: Elijah Newren <[email protected]>
2 parents 05c7dfb + caf849e commit 34295ef

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed
 

‎INSTALL.md

+18-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
* [Installation via Package Manager](#installation-via-package-manager)
66
* [Detailed installation explanation for
77
packagers](#detailed-installation-explanation-for-packagers)
8+
* [Installation as Python Package from
9+
PyPI](#installation-as-python-package-from-pypi)
810
* [Installation via Makefile](#installation-via-makefile)
911
* [Notes for Windows Users](#notes-for-windows-users)
1012

@@ -132,10 +134,21 @@ So, installation might look something like the following:
132134

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

137+
# Installation as Python Package from PyPI
138+
139+
`git-filter-repo` is also available as
140+
[PyPI-package](https://pypi.org/project/git-filter-repo/).
141+
142+
Therefore, it can be installed with [pipx](https://pypa.github.io/pipx/)
143+
or [uv tool](https://docs.astral.sh/uv/concepts/tools/).
144+
Command example for pipx:
145+
146+
`pipx install git-filter-repo`
147+
135148
# Installation via Makefile
136149

137150
Installing should be doable by hand, but a Makefile is provided for those
138-
that prefer it. However, usage of the Makefile really requires overridding
151+
that prefer it. However, usage of the Makefile really requires overriding
139152
at least a couple of the directories with sane values, e.g.
140153

141154
$ make prefix=/usr pythondir=/usr/lib64/python3.8/site-packages install
@@ -146,6 +159,10 @@ you'll still need to do that yourself.
146159

147160
# Notes for Windows Users
148161

162+
git-filter-repo can be installed with multiple tools, such as
163+
[pipx](https://pypa.github.io/pipx/) or a Windows-specific package manager
164+
like Scoop (both of which were covered above).
165+
149166
Sadly, Windows sometimes makes things difficult. Common and historical issues:
150167

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

0 commit comments

Comments
 (0)
Please sign in to comment.