|
1 |
| -========== |
2 |
| -GitPython |
3 |
| -========== |
| 1 | +=================== |
| 2 | +DEPRECATION WARNING |
| 3 | +=================== |
4 | 4 |
|
5 |
| -GitPython is a python library used to interact with git repositories, high-level like git-porcelain, or low-level like git-plumbing. |
| 5 | +This branch contains an abandoned experiment which aimed to change the architecture of git-python entirely. However, as it was never finished, it was good for quite a bit of confusion only. |
6 | 6 |
|
7 |
| -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. |
| 7 | +For the most recent state, please refer to the default branch you find on github. |
8 | 8 |
|
9 |
| -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. |
10 |
| - |
11 |
| -REQUIREMENTS |
12 |
| -============ |
13 |
| - |
14 |
| -* Git ( tested with 1.8.3.4 ) |
15 |
| -* Python Nose - used for running the tests |
16 |
| - * Tested with nose 1.3.0 |
17 |
| -* Mock by Michael Foord used for tests |
18 |
| - * Tested with 1.0.1 |
19 |
| - |
20 |
| -INSTALL |
21 |
| -======= |
22 |
| -If you have downloaded the source code: |
23 |
| - |
24 |
| -.. code-block:: console |
25 |
| -
|
26 |
| - $ python setup.py install |
27 |
| -
|
28 |
| -or if you want to obtain a copy more easily: |
29 |
| - |
30 |
| -.. code-block:: console |
31 |
| -
|
32 |
| - $ easy_install gitpython |
33 |
| -
|
34 |
| -A distribution package can be obtained for manual installation at: |
35 |
| - |
36 |
| -http://pypi.python.org/pypi/GitPython |
37 |
| - |
38 |
| -SOURCE |
39 |
| -====== |
40 |
| - |
41 |
| -GitPython's git repo is available on GitHub, which can be browsed at: |
42 |
| - |
43 |
| -https://github.com/gitpython-developers/GitPython |
44 |
| - |
45 |
| -and cloned using: |
46 |
| - |
47 |
| -.. code-block:: console |
48 |
| -
|
49 |
| - $ git clone git://github.com/gitpython-developers/GitPython.git git-python |
50 |
| -
|
51 |
| -
|
52 |
| -DOCUMENTATION |
53 |
| -============= |
54 |
| -The html-compiled documentation can be found at the following URL: |
55 |
| - |
56 |
| -http://packages.python.org/GitPython/ |
57 |
| - |
58 |
| -MAILING LIST |
59 |
| -============ |
60 |
| -http://groups.google.com/group/git-python |
61 |
| - |
62 |
| -ISSUE TRACKER |
63 |
| -============= |
64 |
| -Issues are tracked on github: |
65 |
| - |
66 |
| -https://github.com/gitpython-developers/GitPython/issues |
67 |
| - |
68 |
| -LICENSE |
69 |
| -======= |
70 |
| - |
71 |
| -New BSD License. See the LICENSE file. |
| 9 | +Thank you. |
0 commit comments