GitPython is a python library used to interact with Git repositories.
Python Other
Latest commit 8dffba5 Mar 9, 2017 @scop scop committed with Byron Spelling fixes
Permalink
Failed to load latest commit information.
doc chore(version): 2.1.3 Mar 8, 2017
etc/sublime-text Fixed up coverage configuration Jan 6, 2015
git Spelling fixes Mar 9, 2017
.appveyor.yml Fixes to support Python 2.6 again. Oct 24, 2016
.codeclimate.yml Add Code Climate configuration Mar 3, 2017
.coveragerc Fixed up coverage configuration Jan 6, 2015
.gitattributes Win, #519: Ensure fixtures & bashscript checked-out eol=lf Sep 28, 2016
.gitignore fix(refs): don't raise StopIteration Mar 28, 2016
.gitmodules GitConfigParser now respects and merges 'include' sections Jan 14, 2015
.travis.yml Fixes to support Python 2.6 again. Oct 24, 2016
AUTHORS check for GIT_WORK_TREE Feb 24, 2017
CHANGES Fix link to latest changelog May 24, 2016
CONTRIBUTING.md doc(README): add basic contribution guidelines Jun 13, 2016
LICENSE Lots of spring cleaning and added in Sphinx documentation. Jan 24, 2009
MANIFEST.in Include doc sources in sdist Apr 28, 2016
Makefile Remove check that didn't work as expected Apr 24, 2016
README.md pip install using camellcase package name Jan 15, 2017
TODO TODO: Removed all entries but left a mesage about where to find the i… May 4, 2010
VERSION chore(version): 2.1.3 Mar 8, 2017
init-tests-after-clone.sh chore(tests): test-initialization via script Jun 21, 2016
requirements.txt Fixes to support Python 2.6 again. Oct 24, 2016
setup.cfg Support universal wheels Apr 4, 2016
setup.py chore(lint): flake8 Dec 8, 2016
test-requirements.txt ci, deps: no PY26, ddt>=1.1.1, CIs `pip install test-requirements` Oct 16, 2016
tox.ini Add Python 3.5 env Apr 14, 2016

README.md

GitPython

GitPython is a python library used to interact with git repositories, high-level like git-porcelain, or low-level like git-plumbing.

It provides abstractions of git objects for easy access of repository data, and additionally allows you to access the git repository more directly using either a pure python implementation, or the faster, but more resource intensive git command implementation.

The object database implementation is optimized for handling large quantities of objects and large datasets, which is achieved by using low-level structures and data streaming.

REQUIREMENTS

GitPython needs the git executable to be installed on the system and available in your PATH for most operations. If it is not in your PATH, you can help GitPython find it by setting the GIT_PYTHON_GIT_EXECUTABLE=<path/to/git> environment variable.

  • Git (1.7.x or newer)
  • Python 2.7 to 3.5, while python 2.6 is supported on a best-effort basis.

The list of dependencies are listed in ./requirements.txt and ./test-requirements.txt. The installer takes care of installing them for you.

INSTALL

If you have downloaded the source code:

python setup.py install

or if you want to obtain a copy from the Pypi repository:

pip install GitPython

Both commands will install the required package dependencies.

A distribution package can be obtained for manual installation at:

http://pypi.python.org/pypi/GitPython

If you like to clone from source, you can do it like so:

git clone https://github.com/gitpython-developers/GitPython
git submodule update --init --recursive
./init-tests-after-clone.sh

Limitations

Leakage of System Resources

GitPython is not suited for long-running processes (like daemons) as it tends to leak system resources. It was written in a time where destructors (as implemented in the __del__ method) still ran deterministically.

In case you still want to use it in such a context, you will want to search the codebase for __del__ implementations and call these yourself when you see fit.

Another way assure proper cleanup of resources is to factor out GitPython into a separate process which can be dropped periodically.

Windows support

For Windows, we do regularly test it on Appveyor CI but not all test-cases pass - you may help improve them by exploring Issue #525.

Python 2.6

Python 2.6 is supported on best-effort basis; which means that it is likely to deteriorate over time.

RUNNING TESTS

Important: Right after cloning this repository, please be sure to have executed the ./init-tests-after-clone.sh script in the repository root. Otherwise you will encounter test failures.

On Windows, make sure you have git-daemon in your PATH. For MINGW-git, the git-daemon.exe exists in Git\mingw64\libexec\git-core\; CYGWIN has no daemon, but should get along fine with MINGW's.

The easiest way to run tests is by using tox a wrapper around virtualenv. It will take care of setting up environments with the proper dependencies installed and execute test commands. To install it simply:

pip install tox

Then run:

tox

For more fine-grained control, you can use nose.

Contributions

Please have a look at the contributions file.

INFRASTRUCTURE

  • User Documentation
  • Questions and Answers
  • Please post on stackoverflow and use the gitpython tag
  • Issue Tracker
    • Post reproducible bugs and feature requests as a new issue. Please be sure to provide the following information if posting bugs:
      • GitPython version (e.g. import git; git.__version__)
      • Python version (e.g. python --version)
      • The encountered stack-trace, if applicable
      • Enough information to allow reproducing the issue

How to make a new release

  • Update/verify the version in the VERSION file
  • Update/verify that the changelog has been updated
  • Commit everything
  • Run git tag <version> to tag the version in Git
  • Run make release
  • Finally, set the upcoming version in the VERSION file, usually be incrementing the patch level, and possibly by appending -dev. Probably you want to git push once more.

LICENSE

New BSD License. See the LICENSE file.

DEVELOPMENT STATUS

codecov Build Status Build status Code Climate Documentation Status Stories in Ready Throughput Graph

Now that there seems to be a massive user base, this should be motivation enough to let git-python return to a proper state, which means

  • no open pull requests
  • no open issues describing bugs