|
1 | 1 | ## GitPython
|
2 | 2 |
|
3 |
| -GitPython is a python library used to interact with git repositories, high-level like git-porcelain, |
| 3 | +GitPython is a python library used to interact with git repositories, high-level like git-porcelain, |
4 | 4 | or low-level like git-plumbing.
|
5 | 5 |
|
6 |
| -It provides abstractions of git objects for easy access of repository data, and additionally |
7 |
| -allows you to access the git repository more directly using either a pure python implementation, |
| 6 | +It provides abstractions of git objects for easy access of repository data, and additionally |
| 7 | +allows you to access the git repository more directly using either a pure python implementation, |
8 | 8 | or the faster, but more resource intensive *git command* implementation.
|
9 | 9 |
|
10 |
| -The object database implementation is optimized for handling large quantities of objects and large datasets, |
| 10 | +The object database implementation is optimized for handling large quantities of objects and large datasets, |
11 | 11 | which is achieved by using low-level structures and data streaming.
|
12 | 12 |
|
13 | 13 |
|
14 | 14 | ### REQUIREMENTS
|
15 | 15 |
|
16 |
| -GitPython needs the `git` executable to be installed on the system and available |
17 |
| -in your `PATH` for most operations. |
18 |
| -If it is not in your `PATH`, you can help GitPython find it by setting |
| 16 | +GitPython needs the `git` executable to be installed on the system and available |
| 17 | +in your `PATH` for most operations. |
| 18 | +If it is not in your `PATH`, you can help GitPython find it by setting |
19 | 19 | the `GIT_PYTHON_GIT_EXECUTABLE=<path/to/git>` environment variable.
|
20 | 20 |
|
21 | 21 | * Git (1.7.x or newer)
|
22 | 22 | * Python 2.7 to 3.5, while python 2.6 is supported on a *best-effort basis*.
|
23 | 23 |
|
24 |
| -The list of dependencies are listed in `./requirements.txt` and `./test-requirements.txt`. |
| 24 | +The list of dependencies are listed in `./requirements.txt` and `./test-requirements.txt`. |
25 | 25 | The installer takes care of installing them for you.
|
26 | 26 |
|
27 | 27 | ### INSTALL
|
@@ -62,10 +62,15 @@ codebase for `__del__` implementations and call these yourself when you see fit.
|
62 | 62 | Another way assure proper cleanup of resources is to factor out GitPython into a
|
63 | 63 | separate process which can be dropped periodically.
|
64 | 64 |
|
65 |
| -#### Best-effort for Python 2.6 and Windows support |
| 65 | +#### Windows support |
66 | 66 |
|
67 |
| -This means that support for these platforms is likely to worsen over time |
68 |
| -as they are kept alive solely by their users, or not. |
| 67 | +For *Windows*, we do regularly test it on [Appveyor CI](https://www.appveyor.com/) |
| 68 | +but not all test-cases pass - you may help improve them by exploring |
| 69 | +[Issue #525](https://github.com/gitpython-developers/GitPython/issues/525). |
| 70 | + |
| 71 | +#### Python 2.6 |
| 72 | + |
| 73 | +Python 2.6 is supported on best-effort basis; which means that it is likely to deteriorate over time. |
69 | 74 |
|
70 | 75 | ### RUNNING TESTS
|
71 | 76 |
|
@@ -100,7 +105,7 @@ Please have a look at the [contributions file][contributing].
|
100 | 105 | * [Questions and Answers](http://stackexchange.com/filters/167317/gitpython)
|
101 | 106 | * Please post on stackoverflow and use the `gitpython` tag
|
102 | 107 | * [Issue Tracker](https://github.com/gitpython-developers/GitPython/issues)
|
103 |
| - * Post reproducible bugs and feature requests as a new issue. |
| 108 | + * Post reproducible bugs and feature requests as a new issue. |
104 | 109 | Please be sure to provide the following information if posting bugs:
|
105 | 110 | * GitPython version (e.g. `import git; git.__version__`)
|
106 | 111 | * Python version (e.g. `python --version`)
|
@@ -131,7 +136,7 @@ New BSD License. See the LICENSE file.
|
131 | 136 | [](https://waffle.io/gitpython-developers/GitPython)
|
132 | 137 | [](https://waffle.io/gitpython-developers/GitPython/metrics/throughput)
|
133 | 138 |
|
134 |
| -Now that there seems to be a massive user base, this should be motivation enough to let git-python |
| 139 | +Now that there seems to be a massive user base, this should be motivation enough to let git-python |
135 | 140 | return to a proper state, which means
|
136 | 141 |
|
137 | 142 | * no open pull requests
|
|
0 commit comments