From 16947d4b4ee09b3dd941f076e1e8fd731af528f3 Mon Sep 17 00:00:00 2001 From: David Linke Date: Sat, 30 Nov 2024 11:04:47 +0100 Subject: [PATCH 1/2] INSTALL.md: Mention pypi / pipx as install option Signed-off-by: David Linke --- INSTALL.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/INSTALL.md b/INSTALL.md index cc5515c1..c73774a4 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -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) @@ -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 @@ -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 From caf849eb83951e356d9e9c1ccfc75f7b0490945c Mon Sep 17 00:00:00 2001 From: David Linke Date: Sat, 30 Nov 2024 10:14:45 +0100 Subject: [PATCH 2/2] INSTALL.md: fix typo Signed-off-by: David Linke --- INSTALL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/INSTALL.md b/INSTALL.md index c73774a4..78b62445 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -148,7 +148,7 @@ Command example for pipx: # Installation via Makefile Installing should be doable by hand, but a Makefile is provided for those -that prefer it. However, usage of the Makefile really requires overridding +that prefer it. However, usage of the Makefile really requires overriding at least a couple of the directories with sane values, e.g. $ make prefix=/usr pythondir=/usr/lib64/python3.8/site-packages install