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.

Sign up for GitHub

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

Jump to bottom

Mention pypi / pipx as simple installation option #487

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Mention pypi / pipx as simple installation option #487

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e268767
Mention pypi / pipx as simple installation option
dalito Jul 4, 2023
926abe9
Moved pypi & pipx installation hint to INSTALL.md
dalito Aug 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down