PyGitUp is a Python implementation of the great
aanand/git-up/. It not only
fully covers the abilities of git-up and should be a drop-in replacement,
but also extends it slightly.
Why use git up?
git pull has two problems:
- It merges upstream changes by default, when it’s really more polite to rebase
unless your collaborators enjoy a commit graph that looks like bedhead.
- It only updates the branch you’re currently on, which means git push will
shout at you for being behind on branches you don’t particularly care about
Why use the Python port?
I wasn’t able to use the original git-up, because I didn’t want to install
a whole Ruby suite just for
git-up and even with Ruby installed, there were
some problems running on my Windows machine. So, my reasons for writing
and using this port are:
- Windows support.
- Written in Python ;)
How do I install it?
- Install git-up via pip: $ pip install git-up
- cd to your project’s directory.
- Run git up and enjoy!
Note for Windows users:
See these instructions
for installing pip, if you haven’t already installed it. And don’t forget
- make your Python/Scripts and Python/Lib/site-packages writable for
- run pip with admin privileges
- or use pip install --user git-up and add %APPDATA%/Python/Scripts
Otherwise pip will refuse to install git-up due to Access denied errors.
Python version compatibility:
Python 2.7, 3.3 and 3.4 are supported :)
Options and Configuration
Command Line Arguments
- 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 for
updates (see below).
To configure PyGitUp, you can set options in your git config. Run
git config [--global] git-up.[name] [value] to set one of these
- git-up.bundler.check [true|*false*]: If set to
true,PyGitUp will check your app for any new bundled gems
and suggest a bundle install if necessary.
- git-up.bundler.autoinstall [true|*false*]: If set to
true,PyGitUp will run bundle install automatically.
Requires git-up.bundler.check to be true.
- git-up.bundler.local [true|*false*]: If you’ve bundle package-ed
your project gems, you can tell PyGitUp to run bundle install
--local for you if it finds missing gems. Much faster than just a plain
old bundle install. Don’t worry if you’re missing gems, it will
backtrack to bundle install if anything goes wrong. Make sure
git-up.bundler.autoinstall is also set to true or it won’t do
- git-up.bundler.rbenv [true|*false*]: If you have rbenv installed,
you can tell PyGitUp to run rbenv rehash for you after it installs
your gems so any binaries will be available right away. Make sure git-up
.bundler.autoinstall is also set to true or it won’t do anything.
- git-up.fetch.prune [*true*|false]: If set to true,
PyGitUp will append the --pruneoption to git fetch and
thus remove any remote tracking branches which no longer exist on
the remote (see git fetch
- git-up.fetch.all [true|*false*]: If set to false, PyGitUp
will only fetch remotes for which there is at least one local
tracking branch. Setting this option will make git up always fetch
from all remotes, which is useful if e.g. you use a remote to push to
your CI system but never check those branches out.
- git-up.rebase.arguments [string]: If set, PyGitUp will use
this string as additional arguments when calling git rebase.
Example: --preserve-merges to recreate merge commits in the
- git-up.rebase.auto [*true*|false]: If set to false,
PyGitUp won’t rebase your branches for you but notify you that
they diverged. This can be useful if you have a lot of in-progress
work that you don’t want to deal with at once, but still want to
update other branches.
- git-up.rebase.log-hook [cmd]: Runs cmd every time a branch
is rebased or fast-forwarded, with the old head as $1 and the new
head as $2. This can be used to view logs or diffs of incoming
echo "changes on $1:"; git log --oneline --decorate $1..$2.
- git-up.rebase.show-hashes [true|*false*]: If set to true,
PyGitUp will show the hashes of the current commit (or the point
where the rebase starts) and the target commit like git pull does.
New in v1.0.0:
- git-up.updates.check [*true*|false]: When running git up --version,
it shows the version number and checks for updates. If you feel
uncomfortable with it, just set it to false to turn off the checks.
The original git-up has been written by aanand:
- Fixed problems when working with branches containing hash signs in their name
- No longer installs a now unneeded script on pip install. Thanks @ekohl
for Pull Request #60.
- Fixed a bug when working with git 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.
Thanks MaximilianR for Pull Request #45.
- Added an command line argument to turn of fetching (--no-fetch). Thanks @buoto
for Pull Request #46.
- Don’t show a stacktrace anymore when stashing fails (#35).
- Fixed a bug that cuased problems with submodules if the submodule had unstashed changes/ Thanks
@Javex for Pull Request #27.
- Fixed a bug when showing the version on Python 3 #34.
- Support for Python 3 has been added. Thanks @r4ts0n
for Pull Request #23
and @Byron for quickly merging a Pull Request
and releasing a new version on which this release depends.
- Now updates submodules when called from git submodule foreach (#8).
- Fixed a problem with setuptools 8.x (#19).
- 3rd party dependencies have been updated
- Added an option to show hashes when fast-forwarding/rebasing like git pull
- Fixed a bug when having branches with both local tracking branches and
remote tracking branches (#17).
- 3rd party dependencies have been updated to fix a problem with a 3rd party
- Fixed some typos in README and PyGitUp output.
- 3rd party dependencies have been updated.
- ahead of upstream messages are now cyan (see aanand/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 by
Prior to v1.1.0, PyGitUp tried to guess the upstream branch for a local
branch 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).
This change may break setups, where a local branch accidently has
the same name as a remote branch without any tracking information set. Prior
to 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 information
using git branch -u <remote>/<remote branch> <local branch> should help.
3rd party dependencies have been updated.
Allows to run git up --version from non-git dirs, too.
Finally PyGitUp 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 (--help won’t work, because
git catches this option and handles it before PyGitUp can do).
- Added option --version to show, what version of PyGitUp 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 (ugly
exception if remote branch has been deleted).
- Fixed issue #3 (didn’t
return to previous branch).
- Fixed problem: check-bundler.rb has not been installed when installing via
PyPI (problems with setup.py).
- Incorporated aanand/git-up#41: Support for bundle install --local and
- Fixed issue #1 (strange
output buffering when having multiple remotes to fetch from).
- Some under-the-hood improvements.
TODO: Brief introduction on what you do with files - including link to relevant help section.