* Added `Repo.merge_base()` implementation. See the `respective issue on github<https://github.com/gitpython-developers/GitPython/issues/169>`_

* `[include]` sections in git configuration files are now respected

* Added `GitConfigParser.rename_section()`

* DOCS: special members like `__init__` are now listed in the API documentation

* DOCS: tutorial section was revised entirely

* Added `Submodule.rename()`

* **POSSIBLY BREAKING CHANGE**: As `rev_parse` will now throw `BadName` as well as `BadObject`, client code will have to catch both exception types.

* A list of all issues can be found here: https://github.com/gitpython-developers/GitPython/issues?q=milestone%3A%22v0.3.6+-+Features%22+

..automodule::git.objects.base

Objects.Blob

GitPython Tutorial

GitPython provides object model access to your git repository. This tutorial iscomposed of multiple sections, each of which explains a real-life usecase.

GitPython provides object model access to your git repository. This tutorial is composed of multiple sections, each of which explains a real-life usecase.

Initialize a Repoobject

Meet the Repotype

The first step is to create a``Repo`` object to represent your repository::

The first step is to create a:class:`git.Repo <git.repo.base.Repo>` object to represent your repository.

..literalinclude::../../git/test/test_docs.py

:language: python

:start-after: def test_init_repo_object

:end-before: # ![1-test_init_repo_object]

In the above example, the directory ``/Users/mtrier/Development/git-python`` is my working repositoryand contains the ``.git`` directory. You can also initialize GitPython with a *bare* repository::

In the above example, the directory ``self.rorepo.working_tree_dir`` equals ``/Users/mtrier/Development/git-python``andis my working repositorywhich contains the ``.git`` directory. You can also initialize GitPython with a *bare* repository.

..literalinclude::../../git/test/test_docs.py

:language: python

:start-after: # [2-test_init_repo_object]

:end-before: # ![2-test_init_repo_object]

A repo object provides high-level access to your data, it allows you to create and delete heads, tags and remotes and access the configuration of therepository::

A repo object provides high-level access to your data, it allows you to create and delete heads, tags and remotes and access the configuration of the repository.

..literalinclude::../../git/test/test_docs.py

:language: python

:start-after: # [3-test_init_repo_object]

:end-before: # ![3-test_init_repo_object]

Query the active branch, query untracked files or whether the repository datahas been modified::

Query the active branch, query untracked files or whether the repository data has been modified.

:end-before: # ![4-test_init_repo_object]

Clone from existing repositories or initialize new empty ones::

Clone from existing repositories or initialize new empty ones.

..literalinclude::../../git/test/test_docs.py

:language: python

:start-after: # [5-test_init_repo_object]

:end-before: # ![5-test_init_repo_object]

Archive the repository contents to a tar file::

Archive the repository contents to a tar file.

..literalinclude::../../git/test/test_docs.py

:language: python

:start-after: # [6-test_init_repo_object]

:end-before: # ![6-test_init_repo_object]

Object Databases

Initializing a repository

In this example, we will initialize an empty repository, add an empty file to the index, and commit the change::

In this example, we will initialize an empty repository, add an empty file to the index, and commit the change.

..literalinclude::../../git/test/test_docs.py

:language: python

:start-after: def test_add_file_and_commit

:end-before: # ![test_add_file_and_commit]

Please have a look at the individual methods as they usually support a vast amount of arguments to customize their behavior.

status=self.proc.wait()

ifstatus!=0:

raiseGitCommandError(self.args,status,self.proc.stderr.read().decode(defenc))

raiseGitCommandError(self.args,status,self.proc.stderr.read())

def__init__(self,repo,binsha,mode=None,path=None):

self.path=path

def__hash__(self):

returnhash(self.path)

fromgit.test.libimportTestBase

fromgitdb.test.libimportwith_rw_directory

fromgit.repo.funimporttouch

classTestGit(TestBase):

classTutorials(TestBase):

deftest_init_repo_object(self,rw_dir):

join=os.path.join

repo=Repo(self.rorepo.working_tree_dir)

assertrepo.bare==False

bare_empty_repo=Repo.init(join(rw_dir,'bare-repo'),bare=True)

assertbare_empty_repo.bare==True

repo.config_reader()# get a config reader for read-only access

cw=repo.config_writer()# get a config writer to change configuration

cw.release()# call release() to be sure changes are written and locks are released

repo.is_dirty()

repo.untracked_files

assertrepo.clone(join(rw_dir,'to/this/path')).__class__isRepo

assertRepo.init(join(rw_dir,'path/for/new/repo')).__class__isRepo

repo.archive(open(join(rw_dir,'repo.tar'),'w'))

deftest_add_file_and_commit(self,rw_dir):

repo_dir=os.path.join(rw_dir,'my-new-repo')

file_name=os.path.join(repo_dir,'new-file')

r=git.Repo.init(repo_dir)

touch(file_name)

open(file_name,'wb').close()

r.index.add([file_name])

r.index.commit("initial commit")

source_url=self._submodule_url()

sm_source_repo=git.Repo.clone_from(source_url,os.path.join(rw_dir,'sm-source'))

sm_source_repo=git.Repo.clone_from(source_url,os.path.join(rw_dir,'sm-source'),b='master')

parent_repo=git.Repo.init(os.path.join(rw_dir,'parent'))

sm=parent_repo.create_submodule('mysubmodule','subdir/submodule',

sm_source_repo.working_tree_dir,branch='master')