From 750e9677b1ce303fa913c3e0754c3884d6517626 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Sat, 29 Nov 2014 13:55:47 +0100 Subject: With docs up on http://gitpython.readthedocs.org, a manually maintained index isn't required anymore [ci skip] --- doc/doc_index/0.3.0/intro.html | 227 ----------------------------------------- 1 file changed, 227 deletions(-) delete mode 100644 doc/doc_index/0.3.0/intro.html (limited to 'doc/doc_index/0.3.0/intro.html') diff --git a/doc/doc_index/0.3.0/intro.html b/doc/doc_index/0.3.0/intro.html deleted file mode 100644 index 0ec68f56..00000000 --- a/doc/doc_index/0.3.0/intro.html +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - - Overview / Install — GitPython v0.3.0-beta2 documentation - - - - - - - - - - -
-

Navigation

- -
- -
-
-
-
- -
-

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

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

    -
    -
    -
    • -

  • GitDB - a pure python git database implementation

    -
    • -
-
-
    -
  • async - asynchronous task scheduling
    • -
-
- -
-
-

Installing GitPython

-

Installing GitPython is easily done using -setuptools. Assuming it is -installed, just run the following from the command-line:

-
# easy_install GitPython
-
-
-

This command will download the latest version of GitPython from the -Python Package Index and install it -to your system. More information about easy_install and pypi can be found -here:

- -

Alternatively, you can install from the distribution using the setup.py -script:

-
# python setup.py install
-
-
-
-

Note

-

In this case, you have to manually install GitDB and async as well. It would be recommended to use the git source repository in that case.

-
-
-
-

Getting Started

-
    -
  • GitPython Tutorial - 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 -API Reference.
    • -
-
-
-

API Reference

-

An organized section of the GitPthon API is at API Reference.

-
-
-

Source Code

-

GitPython’s git repo is available on Gitorious and GitHub, which can be browsed at:

-
- -
-

and cloned using:

-
$ git clone git://gitorious.org/git-python/mainline.git git-python
-$ git clone git://github.com/Byron/GitPython.git git-python
-
-

Initialize all submodules to obtain the required dependencies with:

-
$ cd git-python
-$ git submodule update --init --recursive
-
-

Finally verify the installation by running the nose powered unit tests:

-
$ nosetests
-
-
- - -
-

License Information

-

GitPython is licensed under the New BSD License. See the LICENSE file for -more information.

-
-
- - -
-
-
-
-
-

Table Of Contents

- - -

Previous topic

-

GitPython Documentation

-

Next topic

-

Whats New in 0.3

-

This Page

- - - -
-
-
-
-
-

Navigation

- -
-
- © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors, 2010 Sebastian Thiel. - Created using Sphinx 0.6.5. -
- - \ No newline at end of file -- cgit v1.2.3