diff options
| author | Sebastian Thiel <byronimo@gmail.com> | 2010-11-25 18:10:33 +0100 |
|---|---|---|
| committer | Sebastian Thiel <byronimo@gmail.com> | 2010-11-25 18:18:15 +0100 |
| commit | f8ce24a835cae8c623e2936bec2618a8855c605b (patch) | |
| tree | d4c1d392579e24285381613a4ac1b7cc2d6b6fae /README | |
| parent | 65747a216c67c3101c6ae2edaa8119d786b793cb (diff) | |
| parent | 9004e3a1cf33110f2cbc458f1dc3259c930ad9b4 (diff) | |
| download | GitPython-f8ce24a835cae8c623e2936bec2618a8855c605b.tar.gz GitPython-f8ce24a835cae8c623e2936bec2618a8855c605b.zip | |
-#######->WARNING<-####### Directory structure changed, see commit message
If you use git-python as a submodule of your own project, which alters the sys.path to import it,
you will have to adjust your code to take the changed directory structure into consideration.
Previously, you would put the path
./git-python/lib
into your syspath. All modules moved one level up into the 'git' subdirectory, which means that the 'git-python' directory
now contains the 'git' root package. To allow git to be found, add ./git-python into your path.
To finalize your update, run the following commands
git submodule update --init --recursive
As there will be left-over directories, consider running git-clean
Diffstat (limited to 'README')
| -rw-r--r-- | README | 18 |
1 files changed, 11 insertions, 7 deletions
@@ -2,16 +2,16 @@ GitPython ========== -GitPython is a python library used to interact with Git repositories. +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 port of the grit library in Ruby created by -Tom Preston-Werner and Chris Wanstrath. +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 ( tested with 1.5.3.7 ) +* Git ( tested with 1.7.3.2 ) * Python Nose - used for running the tests * Mock by Michael Foord used for tests. Requires 0.5 @@ -32,17 +32,21 @@ A distribution package can be obtained for manual installation at: SOURCE ====== -GitPython's git repo is available on Gitorious and GitHub, which can be browsed at: +GitPython's git repo is available on 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 +DOCUMENTATION +============= +The html-compiled documentation can be found at the following URL: + +http://packages.python.org/GitPython/ + MAILING LIST ============ http://groups.google.com/group/git-python |