|
1 | 1 | ##GitPython |
2 | 2 |
|
3 | | -GitPython is a python library used to interact with git repositories, high-level like git-porcelain, or low-level like git-plumbing. |
| 3 | +GitPython is a python library used to interact with git repositories, high-level like git-porcelain, |
| 4 | +or low-level like git-plumbing. |
4 | 5 |
|
5 | | -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. |
| 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 | +or the faster, but more resource intensive*git command* implementation. |
6 | 9 |
|
7 | | -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 | +The object database implementation is optimized for handling large quantities of objects and large datasets, |
| 11 | +which is achieved by using low-level structures and data streaming. |
8 | 12 |
|
9 | 13 |
|
10 | 14 | ###REQUIREMENTS |
11 | 15 |
|
12 | | -GitPython needs the`git` executable to be installed on the system and available in your`PATH` for most operations. If it is not in your`PATH`, you can help GitPython find it by setting the`GIT_PYTHON_GIT_EXECUTABLE=<path/to/git>` environment variable. |
| 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 | +the`GIT_PYTHON_GIT_EXECUTABLE=<path/to/git>` environment variable. |
13 | 20 |
|
14 | 21 | * Git (1.7.x or newer) |
15 | 22 | * Python 2.7 to 3.5, while python 2.6 is supported on a*best-effort basis*. |
16 | 23 |
|
17 | | -The list of dependencies are listed in`./requirements.txt` and`./test-requirements.txt`. The installer takes care of installing them for you. |
| 24 | +The list of dependencies are listed in`./requirements.txt` and`./test-requirements.txt`. |
| 25 | +The installer takes care of installing them for you. |
18 | 26 |
|
19 | 27 | ###INSTALL |
20 | 28 |
|
@@ -92,7 +100,8 @@ Please have a look at the [contributions file][contributing]. |
92 | 100 | *[Questions and Answers](http://stackexchange.com/filters/167317/gitpython) |
93 | 101 | * Please post on stackoverflow and use the`gitpython` tag |
94 | 102 | *[Issue Tracker](https://github.com/gitpython-developers/GitPython/issues) |
95 | | -* Post reproducible bugs and feature requests as a new issue. Please be sure to provide the following information if posting bugs: |
| 103 | +* Post reproducible bugs and feature requests as a new issue. |
| 104 | + Please be sure to provide the following information if posting bugs: |
96 | 105 | * GitPython version (e.g.`import git; git.__version__`) |
97 | 106 | * Python version (e.g.`python --version`) |
98 | 107 | * The encountered stack-trace, if applicable |
@@ -121,7 +130,8 @@ New BSD License. See the LICENSE file. |
121 | 130 | [](https://waffle.io/gitpython-developers/GitPython) |
122 | 131 | [](https://waffle.io/gitpython-developers/GitPython/metrics/throughput) |
123 | 132 |
|
124 | | -Now that there seems to be a massive user base, this should be motivation enough to let git-python return to a proper state, which means |
| 133 | +Now that there seems to be a massive user base, this should be motivation enough to let git-python |
| 134 | +return to a proper state, which means |
125 | 135 |
|
126 | 136 | * no open pull requests |
127 | 137 | * no open issues describing bugs |
|