Repository files navigation

PyGitUp is a Python port ofaanand/git-up. It not onlyfully covers the abilities of git-up and should be a drop-in replacement,but also extends it slightly.

git pull has two problems:

• It merges upstream changes by default, when it's really more polite torebaseover them,unless your collaborators enjoy a commit graph that looks like bedhead.
• It only updates the branch you're currently on, which means git push willshout at you for being behind on branches you don't particularly care aboutright now.

(https://github.com/aanand/git-up/)

I wasn't able to use the originalgit-up, because I didn't want to installa whole Ruby suite just for git-up and even with Ruby installed, there weresome problems running on my Windows machine. So, my reasons for writingand using this port are:

1. Windows support.
2. Written in Python ;)

1. Installgit-up viapip:$ uv tool install git-up
2. cd to your project's directory.
3. Rungit up and enjoy!

Homebrew users can also usebrew:brew install pygitup

Could also checkout the.github/workflows/ci-workflow.yml

1. clone repo andcd to repo directory.
2. Installpoetry as guided bypoetry installation doc
3. Runpoetry install
4. Run program withpoetry run git-up
5. Run all tests withpoetry run pytest -v --cov=PyGitUp orpoetry run pytest -v --cov=PyGitUp --cov-report html
6. Run one test withpoetry run pytest -q PyGitUp/tests/test_version.py -v --cov=PyGitUp

Seethese instructionsfor installing pip, if you haven't already installed it. And don't forgetto either:

• make yourPython/Scripts andPython/Lib/site-packages writable foryou,
• runpip with admin privileges
• or usepip install --user git-up and add%APPDATA%/Python/Scriptsto%PATH%.

Otherwise pip will refuse to installgit-up due toAccess denied errors.

Python 3.7 and upwards are supported :)

• git up -h shows a help message.
• git up --quiet suppresses all output except for error messages.
• git up --no-fetch skips fetching the remote and rebases all local branches.
• git up --version shows the current version and optionally checks forupdates (see below).

To configurePyGitUp, you can set options in your git config. Rungit config [--global] git-up.[name] [value] to set one of theseoptions:

• git-up.fetch.prune [*true*|false]: If set totrue,PyGitUp will append the--pruneoption togit fetch andthus remove any remote tracking branches which no longer exist onthe remote (seegit fetch--help).
• git-up.fetch.all [true|*false*]: If set tofalse,PyGitUpwill only fetch remotes for which there is at least one localtracking branch. Setting this option will makegit up always fetchfrom all remotes, which is useful if e.g. you use a remote to push toyour CI system but never check those branches out.
• git-up.push.auto [true|*false*]: Push the current branch afterrebasing and fast-forwarding.
• git-up.push.all [true|*false*]: Push all branches when auto-pushing.
• git-up.push.tags [true|*false*]: Push tags when auto-pushing.
• git-up.rebase.arguments [string]: If set,PyGitUp will usethis string as additional arguments when callinggit rebase.Example:--preserve-merges to recreate merge commits in therebased branch.
• git-up.rebase.auto [*true*|false]: If set tofalse,PyGitUp won't rebase your branches for you but notify you thatthey diverged. This can be useful if you have a lot of in-progresswork that you don't want to deal with at once, but still want toupdate other branches.
• git-up.rebase.log-hook [cmd]: Runscmd every time a branchis rebased or fast-forwarded, with the old head as$1 and the newhead as$2. This can be used to view logs or diffs of incomingchanges. Example:echo "changes on $1:"; git log --oneline --decorate $1..$2.
• git-up.rebase.show-hashes [true|*false*]: If set totrue,PyGitUp will show the hashes of the current commit (or the pointwhere the rebase starts) and the target commit likegit pull does.

• git-up.updates.check [*true*|false]: When runninggit up --version,it shows the version number and checks for updates. If you feeluncomfortable with it, just set it tofalse to turn off the checks.

The originalgit-up has been written by aanand:aanand/git-up/.

• Switch topackaging instead ofpkg_resources. Closes#139.
• Fix top-level directory detection on MinGW.
• Update dependencies and switch to the uv package manager.

• Improve logging when updating large repositories. Thanks@bdmartin forPull Request #132.
• Drop support for Python 3.7

• Add support for Python 3.11. Thanks@hugovk forPull Request #118.

• Switch to Python'sargparse for CLI argument parsing. Thanks@ekohl forPull Request #96.

• Drop support for Python 3.6 (following GitPython)
• Update PyGitUp's CLI argument parserClickto version 8.0. Thanks@hugovkforPull Request #109.
• Update other dependencies

• Remove old Python 2 code. Thanks@hugovkforPull Request #104.

• Update dependencies

• Drop Python 2 support in order to fixIssue 102
• Drop Ruby Bundler integration
• Migrate tests topy.test

• Upgrade to click>=7.0.0. Thanks@no-preserve-rootforPull Request #87.

• Skip stashing changes when possible. Thanks@ChronialforPull Request #86.
• Added faster fast-forward on branches that are not checked out. Thanks@ChronialforPull Request #83.

• Fixed version requirement for Click dependency (#82).

• Fixed crash on Cygwin with rebase log hook enabled (#80).

• Added auto-push support. Thanks@WoLpHforPull Request #74.

• Added shorthand commandline arguments (-V, -q, -h, see#73).

• 3rd party dependencies have been updated (see#65).

• Fixed problems when working with branches containing hash signs in their name(#55).
• No longer installs a now unneeded script onpip install. Thanks@ekohlforPull Request #60.

• Fixed a bug when working withgit worktree (#58).

• Fixed a bug with GitPython <= 2.0.8 (#56,#57).

• Switched the command line argument parsing library (#53).

• Include tests in PyPI distribution (#51).

• 3rd party dependencies have been updated.
• Dependencies on 3rd party libraries have been loosened to better interact with other installed packages.ThanksMaximilianR forPull Request #45.
• Added an command line argument to turn of fetching (--no-fetch). Thanks@buotoforPull Request #46.
• Don't show a stacktrace anymore when stashing fails (#35).
• Fixed a bug that caused problems with submodules if the submodule had unstashed changes/ Thanks@Javex forPull Request #27.

• Fixed a bug when showing the version on Python 3#34.

• Support for Python 3 has been added. Thanks@r4ts0nforPull Request #23and@Byron for quickly merging a Pull RequestinGitPythonand releasing a new version on which this release depends.

• Now updates submodules when called fromgit submodule foreach (#8).

• Fixed a problem withsetuptools 8.x (#19).
• 3rd party dependencies have been updated

• Added an option to show hashes when fast-forwarding/rebasing likegit pulldoes (git-up.rebase.show-hashes).
• Fixed a bug when having branches with both local tracking branches andremote tracking branches (#17).

• 3rd party dependencies have been updated to fix a problem with a 3rd partylibrary (#18).

• Fixed some typos in README andPyGitUp output.
• 3rd party dependencies have been updated.

• ahead of upstream messages are now cyan (seeaanand/git-up#60).
• Fixed problem when using % in the log hook (#11).

• Fixed problems with the dependency declaration.

• Fix for#7(AttributeError: 'GitUp' object has no attribute 'git') introduced byv1.1.0.

• Prior to v1.1.0,PyGitUp tried to guess the upstream branch for a localbranch by looking for a branch on any remote with the same name. With v1.1.0,PyGitUp stops guessing and uses the upstream branch config instead.

  This by the way fixes issue#6(git up doesn't work with local only branches).

  Note:This change may break setups, where a local branch accidentally hasthe same name as a remote branch without any tracking information set. Priorto v1.1.0,git up would still fetch and rebase from the remote branch.If you run into troubles with such a setup, setting tracking informationusinggit branch -u <remote>/<remote branch> <local branch> should help.

• 3rd party dependencies have been updated.

• Allows to rungit up --version from non-git dirs, too.

FinallyPyGitUp reaches 1.0.0. You can consider it stable now :)

• Added a comprehensive test suite, now with a coverage of about 90%.
• Lots of code cleanup.
• Added option-h to display a help screen (--helpwon't work, becausegit catches this option and handles it beforePyGitUp can do).
• Added option--version to show, what version ofPyGitUp is running.Also checks for updates (can be disabled, see configuration).
• Added option--quiet to be quiet and only display error messages.

• Fixed issue#4 (uglyexception if remote branch has been deleted).

• Fixed issue#3 (didn'treturn to previous branch).

• Fixed problem: check-bundler.rb has not been installed when installing viaPyPI (problems with setup.py).

• Incorporatedaanand/git-up#41: Support forbundle install --local andrbenv rehash.
• Fixed issue#1 (strangeoutput buffering when having multiple remotes to fetch from).
• Some under-the-hood improvements.

• Initial Release