Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit86aa873

Browse files
committed
doc: Explain Windows compatibility status, mention#525 asking for help
1 parenta46f670 commit86aa873

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

‎README.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
##GitPython
22

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,
44
or low-level like git-plumbing.
55

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,
88
or the faster, but more resource intensive*git command* implementation.
99

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,
1111
which is achieved by using low-level structures and data streaming.
1212

1313

1414
###REQUIREMENTS
1515

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
1919
the`GIT_PYTHON_GIT_EXECUTABLE=<path/to/git>` environment variable.
2020

2121
* Git (1.7.x or newer)
2222
* Python 2.7 to 3.5, while python 2.6 is supported on a*best-effort basis*.
2323

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`.
2525
The installer takes care of installing them for you.
2626

2727
###INSTALL
@@ -62,10 +62,15 @@ codebase for `__del__` implementations and call these yourself when you see fit.
6262
Another way assure proper cleanup of resources is to factor out GitPython into a
6363
separate process which can be dropped periodically.
6464

65-
####Best-effort for Python 2.6 andWindows support
65+
####Windows support
6666

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.
6974

7075
###RUNNING TESTS
7176

@@ -100,7 +105,7 @@ Please have a look at the [contributions file][contributing].
100105
*[Questions and Answers](http://stackexchange.com/filters/167317/gitpython)
101106
* Please post on stackoverflow and use the`gitpython` tag
102107
*[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.
104109
Please be sure to provide the following information if posting bugs:
105110
* GitPython version (e.g.`import git; git.__version__`)
106111
* Python version (e.g.`python --version`)
@@ -131,7 +136,7 @@ New BSD License. See the LICENSE file.
131136
[![Stories in Ready](https://badge.waffle.io/gitpython-developers/GitPython.png?label=ready&title=Ready)](https://waffle.io/gitpython-developers/GitPython)
132137
[![Throughput Graph](https://graphs.waffle.io/gitpython-developers/GitPython/throughput.svg)](https://waffle.io/gitpython-developers/GitPython/metrics/throughput)
133138

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
135140
return to a proper state, which means
136141

137142
* no open pull requests

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp