blob: 5118756975399f7c2bc2d9db27d1564d2ca863c7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
.. _intro_toplevel:
==================
Overview / Install
==================
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
============
* Tested with `Git`_ 1.7.0 or newer
* `Python Nose`_ - used for running the tests
* `Mock by Michael Foord`_ used for tests. Requires version 0.5
.. _Git: http://git-scm.com/
.. _Python Nose: http://code.google.com/p/python-nose/
.. _Mock by Michael Foord: http://www.voidspace.org.uk/python/mock.html
Installing GitPython
====================
Installing GitPython is easily done using
`setuptools`_. Assuming it is
installed, just run the following from the command-line:
.. sourcecode:: none
# easy_install GitPython
This command will download the latest version of GitPython from the
`Python Package Index <http://pypi.python.org/pypi/GitPython>`_ and install it
to your system. More information about ``easy_install`` and pypi can be found
here:
* `setuptools`_
* `install setuptools <http://peak.telecommunity.com/DevCenter/EasyInstall#installation-instructions>`_
* `pypi <http://pypi.python.org/pypi/SQLAlchemy>`_
.. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools
Alternatively, you can install from the distribution using the ``setup.py``
script:
.. sourcecode:: none
# python setup.py install
Getting Started
===============
* :ref:`tutorial-label` - This tutorial provides a walk-through of some of
the basic functionality and concepts used in GitPython. It, however, is not
exhaustive so you are encouraged to spend some time in the
:ref:`api_reference_toplevel`.
API Reference
=============
An organized section of the GitPthon API is at :ref:`api_reference_toplevel`.
Source Code
===========
GitPython's git repo is available on Gitorious and GitHub, which can be browsed at:
* http://gitorious.org/projects/git-python/
* http://github.com/Byron/GitPython
and cloned using::
$ git clone git://gitorious.org/git-python/mainline.git git-python
$ git clone git://github.com/Byron/GitPython.git git-python
Mailing List
============
http://groups.google.com/group/git-python
Issue Tracker
=============
http://byronimo.lighthouseapp.com/projects/51787-gitpython/milestones
License Information
===================
GitPython is licensed under the New BSD License. See the LICENSE file for
more information.
|
