From e2687677bee3873789f126e77f9628b786798df2 Mon Sep 17 00:00:00 2001 From: David Linke Date: Tue, 4 Jul 2023 10:25:09 +0200 Subject: [PATCH 1/2] Mention pypi / pipx as simple installation option Signed-off-by: David Linke --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index c97fd71a..9384b645 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,11 @@ filter-repo requires: installation for basic use on many systems trivial: just place that file into your $PATH. +`git-filter-repo` is also available as +[PyPI-package](https://pypi.org/project/git-filter-repo/). Therefore, it +can be [pipx](https://pypa.github.io/pipx/)-installed (also on Windows): +`pipx install git-filter-repo` + See [INSTALL.md](INSTALL.md) for things beyond basic usage or special cases. The more involved instructions are only needed if one of the following apply: From 926abe9672d584af85dae989e3f96193ee969443 Mon Sep 17 00:00:00 2001 From: David Linke Date: Sat, 17 Aug 2024 19:59:44 +0200 Subject: [PATCH 2/2] Moved pypi & pipx installation hint to INSTALL.md --- INSTALL.md | 20 +++++++++++++++++++- README.md | 5 ----- 2 files changed, 19 insertions(+), 6 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 2e28b492..823b7366 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -2,6 +2,7 @@ * [Pre-requisites](#pre-requisites) * [Simple Installation](#simple-installation) + * [Installation as Python Package from PyPI](#installation-as-python-package-from-pypi) * [Installation via Package Manager](#installation-via-package-manager) * [Detailed installation explanation for packagers](#detailed-installation-explanation-for-packagers) @@ -40,6 +41,15 @@ you need to make sure you have a `git_filter_repo.py` file which is either a link to or copy of `git-filter-repo`, and you need to place that git_filter_repo.py file in $PYTHONPATH. +# 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 [pipx](https://pypa.github.io/pipx/)-installed: + +`pipx install git-filter-repo` + # Installation via Package Manager If you want to install via some [package @@ -147,7 +157,15 @@ you'll still need to do that yourself. # Notes for Windows Users -Windows likes to make things difficult. Common and historical issues: +Installing `git-filter-repo` via pip into a virtual envirinment is known to +work well. This makes `git-filter-repo` available as executable script in the +virtual env. + +An alternative is using [pipx](https://pypa.github.io/pipx/) that is made to +simplify installing and running Python-scripts. It does also work for +`git-filter-repo` on Windows. + +If you face problems, look through these common and historical issues: * **Non-functional Python stub**: Windows apparently ships with a [non-functional diff --git a/README.md b/README.md index 9384b645..c97fd71a 100644 --- a/README.md +++ b/README.md @@ -48,11 +48,6 @@ filter-repo requires: installation for basic use on many systems trivial: just place that file into your $PATH. -`git-filter-repo` is also available as -[PyPI-package](https://pypi.org/project/git-filter-repo/). Therefore, it -can be [pipx](https://pypa.github.io/pipx/)-installed (also on Windows): -`pipx install git-filter-repo` - See [INSTALL.md](INSTALL.md) for things beyond basic usage or special cases. The more involved instructions are only needed if one of the following apply: