Merge pull request #519 from ankostis/appveyor

Test project on Windows with MINGW/Cygwin git (conda2.7&3.4/cpy-3.5)

Author: Byron

.appveyor.yml

@@ -0,0 +1,83 @@
+# CI on Windows via appveyor
+environment:
+    GIT_DAEMON_PATH:   "C:\\Program Files\\Git\\mingw64\\libexec\\git-core"
+    CYGWIN_GIT_PATH:   "C:\\cygwin\\bin;%GIT_DAEMON_PATH%"
+    CYGWIN64_GIT_PATH: "C:\\cygwin64\\bin;%GIT_DAEMON_PATH%"
+
+    matrix:
+        ## MINGW
+        #
+      - PYTHON: "C:\\Python27"
+        PYTHON_VERSION: "2.7"
+        GIT_PATH: "%GIT_DAEMON_PATH%"
+      - PYTHON: "C:\\Python34-x64"
+        PYTHON_VERSION: "3.4"
+        GIT_PATH: "%GIT_DAEMON_PATH%"
+      - PYTHON: "C:\\Python35-x64"
+        PYTHON_VERSION: "3.5"
+        GIT_PATH: "%GIT_DAEMON_PATH%"
+      - PYTHON: "C:\\Miniconda35-x64"
+        PYTHON_VERSION: "3.5"
+        IS_CONDA: "yes"
+        GIT_PATH: "%GIT_DAEMON_PATH%"
+
+      #   ## Cygwin
+      #   #
+      # - PYTHON: "C:\\Miniconda-x64"
+      #   PYTHON_VERSION: "2.7"
+      #   IS_CONDA: "yes"
+      #   GIT_PATH: "%CYGWIN_GIT_PATH%"
+      # - PYTHON: "C:\\Python34-x64"
+      #   PYTHON_VERSION: "3.4"
+      #   GIT_PATH: "%CYGWIN_GIT_PATH%"
+      # - PYTHON: "C:\\Python35-x64"
+      #   PYTHON_VERSION: "3.5"
+      #   GIT_PATH: "%CYGWIN64_GIT_PATH%"
+
+
+install:
+    - set PATH=%PYTHON%;%PYTHON%\Scripts;%GIT_PATH%;%PATH%
+
+    ## Print architecture, python & git used for debugging.
+    #
+    - |
+        uname -a
+        where git git-daemon python pip pip3 pip34
+        python --version
+        python -c "import struct; print(struct.calcsize('P') * 8)"
+
+    - IF "%IS_CONDA%"=="yes" (
+        conda info -a &
+        conda install --yes --quiet  pip
+      )
+    - pip install  nose ddt wheel coveralls
+    -   IF "%PYTHON_VERSION%"=="2.7" (
+            pip install mock
+        )
+
+    ## Copied from `init-tests-after-clone.sh`.
+    #
+    - |
+        git submodule update --init --recursive
+        git fetch --tags
+        git tag __testing_point__
+        git checkout master || git checkout -b master
+        git reset --hard HEAD~1
+        git reset --hard HEAD~1
+        git reset --hard HEAD~1
+        git reset --hard __testing_point__
+
+    ## For commits performed with the default user.
+    - |
+        git config --global user.email "travis@ci.com"
+        git config --global user.name "Travis Runner"
+
+    - pip install -e .
+
+build: false
+
+test_script:
+    - nosetests --with-coverage
+
+#on_success:
+#    - IF "%PYTHON_VERSION%"=="3.4" (coveralls)

.gitattributes

@@ -0,0 +1,2 @@
+git/test/fixtures/* eol=lf
+init-tests-after-clone.sh

.travis.yml

@@ -16,7 +16,7 @@ git:
 install:
   - git submodule update --init --recursive
   - git fetch --tags
-  - pip install coveralls flake8 sphinx
+  - pip install coveralls flake8 ddt sphinx
 
   # generate some reflog as git-python tests need it (in master)
   - ./init-tests-after-clone.sh
@@ -31,8 +31,9 @@ script:
   # Make sure we limit open handles to see if we are leaking them
   - ulimit -n 96
   - ulimit -n
-  - nosetests -v --with-coverage
-  - flake8
-  - cd doc && make html
+  - nosetests --with-coverage
+  - if [ "$TRAVIS_PYTHON_VERSION" == '3.4' ]; then flake8; fi
+  - if [ "$TRAVIS_PYTHON_VERSION" == '3.5' ]; then cd doc && make html; fi
+  -
 after_success:
   - coveralls

README.md

@@ -1,20 +1,28 @@
 ## GitPython
 
-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 python library used to interact with git repositories, high-level like git-porcelain, 
+or low-level like git-plumbing.
 
-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.
+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.
+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
 
-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.
+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.
 
 * Git (1.7.x or newer)
 * Python 2.7 to 3.5, while python 2.6 is supported on a *best-effort basis*.
 
-The list of dependencies are listed in `./requirements.txt` and `./test-requirements.txt`. The installer takes care of installing them for you.
+The list of dependencies are listed in `./requirements.txt` and `./test-requirements.txt`. 
+The installer takes care of installing them for you.
 
 ### INSTALL
 
@@ -31,7 +39,7 @@ Both commands will install the required package dependencies.
 A distribution package can be obtained for manual installation at:
 
     http://pypi.python.org/pypi/GitPython
-    
+
 If you like to clone from source, you can do it like so:
 
 ```bash
@@ -45,7 +53,7 @@ git submodule update --init --recursive
 #### Leakage of System Resources
 
 GitPython is not suited for long-running processes (like daemons) as it tends to
-leak system resources. It was written in a time where destructors (as implemented 
+leak system resources. It was written in a time where destructors (as implemented
 in the `__del__` method) still ran deterministically.
 
 In case you still want to use it in such a context, you will want to search the
@@ -61,17 +69,25 @@ as they are kept alive solely by their users, or not.
 
 ### RUNNING TESTS
 
-*Important*: Right after cloning this repository, please be sure to have executed the `init-tests-after-clone.sh` script in the repository root. Otherwise you will encounter test failures.
+*Important*: Right after cloning this repository, please be sure to have executed
+the `./init-tests-after-clone.sh` script in the repository root. Otherwise
+you will encounter test failures.
+
+On *Windows*, make sure you have `git-daemon` in your PATH.  For MINGW-git, the `git-daemon.exe`
+exists in `Git\mingw64\libexec\git-core\`; CYGWIN has no daemon, but should get along fine
+with MINGW's.
 
-The easiest way to run test is by using [tox](https://pypi.python.org/pypi/tox) a wrapper around virtualenv. It will take care of setting up environnements with the proper dependencies installed and execute test commands. To install it simply:
+The easiest way to run tests is by using [tox](https://pypi.python.org/pypi/tox)
+a wrapper around virtualenv. It will take care of setting up environnements with the proper
+dependencies installed and execute test commands. To install it simply:
 
     pip install tox
 
 Then run:
 
     tox
-    
-    
+
+
 For more fine-grained control, you can use `nose`.
 
 ### Contributions
@@ -84,7 +100,8 @@ Please have a look at the [contributions file][contributing].
 * [Questions and Answers](http://stackexchange.com/filters/167317/gitpython)
  * Please post on stackoverflow and use the `gitpython` tag
 * [Issue Tracker](https://github.com/gitpython-developers/GitPython/issues)
-  * Post reproducible bugs and feature requests as a new issue. Please be sure to provide the following information if posting bugs:
+  * Post reproducible bugs and feature requests as a new issue. 
+    Please be sure to provide the following information if posting bugs:
     * GitPython version (e.g. `import git; git.__version__`)
     * Python version (e.g. `python --version`)
     * The encountered stack-trace, if applicable
@@ -100,7 +117,7 @@ Please have a look at the [contributions file][contributing].
 * Finally, set the upcoming version in the `VERSION` file, usually be
   incrementing the patch level, and possibly by appending `-dev`. Probably you
   want to `git push` once more.
-  
+
 ### LICENSE
 
 New BSD License.  See the LICENSE file.
@@ -113,7 +130,8 @@ New BSD License.  See the LICENSE file.
 [![Stories in Ready](https://badge.waffle.io/gitpython-developers/GitPython.png?label=ready&title=Ready)](https://waffle.io/gitpython-developers/GitPython)
 [![Throughput Graph](https://graphs.waffle.io/gitpython-developers/GitPython/throughput.svg)](https://waffle.io/gitpython-developers/GitPython/metrics/throughput)
 
-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
+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
 
 * no open pull requests
 * no open issues describing bugs

doc/source/conf.py

@@ -50,7 +50,8 @@
 # built documents.
 #
 # The short X.Y version.
-VERSION = open(os.path.join(os.path.dirname(__file__),"..", "..", 'VERSION')).readline().strip()
+with open(os.path.join(os.path.dirname(__file__),"..", "..", 'VERSION')) as fd:
+    VERSION = fd.readline().strip()
 version = VERSION
 # The full version, including alpha/beta/rc tags.
 release = VERSION