environment:

GIT_DAEMON_PATH:"C:\\Program Files\\Git\\mingw64\\libexec\\git-core"

CYGWIN_GIT_PATH:"C:\\cygwin\\bin;%GIT_DAEMON_PATH%"

CYGWIN64_GIT_PATH:"C:\\cygwin64\\bin;%GIT_DAEMON_PATH%"

matrix:

-PYTHON:"C:\\Python27"

PYTHON_VERSION:"2.7"

GIT_PATH:"%GIT_DAEMON_PATH%"

-PYTHON:"C:\\Python34-x64"

PYTHON_VERSION:"3.4"

GIT_PATH:"%GIT_DAEMON_PATH%"

-PYTHON:"C:\\Python35-x64"

PYTHON_VERSION:"3.5"

GIT_PATH:"%GIT_DAEMON_PATH%"

-PYTHON:"C:\\Miniconda35-x64"

PYTHON_VERSION:"3.5"

IS_CONDA:"yes"

GIT_PATH:"%GIT_DAEMON_PATH%"

install:

-set PATH=%PYTHON%;%PYTHON%\Scripts;%GIT_PATH%;%PATH%

-|

-IF "%IS_CONDA%"=="yes" (

-pip install nose ddt wheel coveralls

-IF "%PYTHON_VERSION%"=="2.7" (

-|

-|

-pip install -e .

build:false

test_script:

-nosetests -v --with-coverage

git/test/fixtures/*eol=lf

install:

-git submodule update --init --recursive

-git fetch --tags

-pip install coveralls flake8 sphinx

-pip install coveralls flake8ddtsphinx

-./init-tests-after-clone.sh

-cat git/test/fixtures/.gitconfig >> ~/.gitconfig

script:

-ulimit -n96

-ulimit -n110

-ulimit -n

-nosetests -v --with-coverage

-flake8

-cd doc && make html

-if [ "$TRAVIS_PYTHON_VERSION" == '3.4' ]; then flake8; fi

-if [ "$TRAVIS_PYTHON_VERSION" == '3.5' ]; then cd doc && make html; fi

-

after_success:

-coveralls

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

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.

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.

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.

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.

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.

The list of dependencies are listed in`./requirements.txt` and`./test-requirements.txt`.

The installer takes care of installing them for you.

A distribution package can be obtained for manual installation at:

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

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

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

Another way assure proper cleanup of resources is to factor out GitPython into a

separate process which can be dropped periodically.

For*Windows*, we do regularly test it on[Appveyor CI](https://www.appveyor.com/)

but not all test-cases pass - you may help improve them by exploring

[Issue#525](https://github.com/gitpython-developers/GitPython/issues/525).

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

*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.

*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.

The easiest way to run test is by using[tox](https://pypi.python.org/pypi/tox) a wrapper around virtualenv. It will take care of setting up environnements with the proper dependencies installed and execute test commands. To install it simply:

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](https://pypi.python.org/pypi/tox)

a wrapper around virtualenv. It will take care of setting up environnements with the proper

dependencies installed and execute test commands. To install it simply:

Then run:

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

*[Questions and Answers](http://stackexchange.com/filters/167317/gitpython)

* Please post on stackoverflow and use the`gitpython` tag

*[Issue Tracker](https://github.com/gitpython-developers/GitPython/issues)

* Post reproducible bugs and feature requests as a new issue. Please be sure to provide the following information if posting bugs:

* 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

* 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.

New BSD License. See the LICENSE file.

[](https://travis-ci.org/gitpython-developers/GitPython)

[](https://ci.appveyor.com/project/Byron/gitpython/branch/master)

[](https://codeclimate.com/github/gitpython-developers/GitPython)

[](https://readthedocs.org/projects/gitpython/?badge=stable)

[](https://waffle.io/gitpython-developers/GitPython)

[](https://waffle.io/gitpython-developers/GitPython/metrics/throughput)

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

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

[contributing]:https://github.com/gitpython-developers/GitPython/blob/master/README.md

[contributing]:https://github.com/gitpython-developers/GitPython/blob/master/CONTRIBUTING.md

VERSION=open(os.path.join(os.path.dirname(__file__),"..","..",'VERSION')).readline().strip()

withopen(os.path.join(os.path.dirname(__file__),"..","..",'VERSION'))asfd:

VERSION=fd.readline().strip()

* `Python`_ 2.7 or newer

Since GitPython 2.0.0. Please note that python 2.6 is still reasonably well supported, but might

deteriorate over time.

deteriorate over time. Support is provided on a best-effort basis only.

* `Git`_ 1.7.0 or newer

It should also work with older versions, but it may be that some operations

involving remotes will not work as expected.

Another way assure proper cleanup of resources is to factor out GitPython into a

separate process which can be dropped periodically.

Best-effort for Python 2.6 and Windows support

This means that support for these platforms is likely to worsen over time

as they are kept alive solely by their users, or not.

Getting Started