diff options
| author | Sebastian Thiel <byronimo@gmail.com> | 2010-07-01 17:58:19 +0200 |
|---|---|---|
| committer | Sebastian Thiel <byronimo@gmail.com> | 2010-07-01 17:58:19 +0200 |
| commit | fd96cceded27d1372bdc1a851448d2d8613f60f3 (patch) | |
| tree | 5b53f288a3379e260f46a65d08691fceec4a0ca3 /doc/doc_index/0.2/_sources/intro.txt | |
| parent | 6917ae4ce9eaa0f5ea91592988c1ea830626ac3a (diff) | |
| parent | c3bd05b426a0e3dec8224244c3c9c0431d1ff130 (diff) | |
| download | GitPython-fd96cceded27d1372bdc1a851448d2d8613f60f3.tar.gz GitPython-fd96cceded27d1372bdc1a851448d2d8613f60f3.zip | |
Merge branch 'docs'
Diffstat (limited to 'doc/doc_index/0.2/_sources/intro.txt')
| -rw-r--r-- | doc/doc_index/0.2/_sources/intro.txt | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/doc/doc_index/0.2/_sources/intro.txt b/doc/doc_index/0.2/_sources/intro.txt new file mode 100644 index 00000000..476ab4ec --- /dev/null +++ b/doc/doc_index/0.2/_sources/intro.txt @@ -0,0 +1,93 @@ +.. _intro_toplevel: + +================== +Overview / Install +================== + +GitPython is a python library used to interact with Git repositories. + +GitPython was a port of the grit_ library in Ruby created by +Tom Preston-Werner and Chris Wanstrath, but grew beyond its heritage through its improved design and performance. + +.. _grit: http://grit.rubyforge.org + +Requirements +============ + +* Git_ tested with 1.5.3.7 +* Requires Git_ 1.6.5.4 or newer if index.add function is to be used +* `Python Nose`_ - used for running the tests +* `Mock by Michael Foord`_ used for tests. Requires 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. + |
