Merge pull request scikit-learn-contrib#22 from vighneshbirodkar/appv

[MRG] Adding Appveyor CI

.travis.yml

@@ -18,6 +18,6 @@ env:
     - DISTRIB="conda" PYTHON_VERSION="3.5" COVERAGE="true"
       NUMPY_VERSION="1.10.4" SCIPY_VERSION="0.17.0" CYTHON_VERSION="0.23.4"
 
-install: source ci_scripts/install.sh
-script: bash ci_scripts/test.sh
-after_success: source ci_scripts/success.sh
+install: source ci_scripts/travis/install.sh
+script: bash ci_scripts/travis/test.sh
+after_success: source ci_scripts/travis/success.sh

README.md

@@ -130,7 +130,30 @@ Coveralls can start monitoring it. The project already contains the required
 configuration for Coveralls to work. All subsequent builds after adding your
 project will generate a coverage report.
 
-### 6. Setting up Circle CI
+### 6. Setting up Appveyor
+[Appveyor](https://www.appveyor.com/) provides continuous intergration on the
+windows  platform. Currently, Appveyor can also be used to build platform
+specific Windows wheels, which can be uploaded to a Cloud Service provider and
+be made available via a Content Delivery Network (CDN). To setup Appveyor to
+build your project you need to sign up on Appveyor and authorize it. Appveyor
+configaration is governed by the `appveyor.yml` file. You have to change the
+following variables in it to match the requirements of your project.
+
+| Variable | Value|
+|----------|------|
+| `PROJECT_NAME`  | The name of your project. This should be the same as the `name` field in `setup.py`  |
+| `MODULE` | The name of the module you want to be tested |
+| `CLOUD_STORAGE` | A constant which indicates which Cloud Storage service provider to use. It should be one among the [Supported Providers](https://libcloud.readthedocs.io/en/latest/storage/supported_providers.html) |
+| `CLOUD_CONTAINER` | The name of a container with your Cloud Storage service provider where the built files will be uploaded.|
+| `WHEELHOUSE_UPLOADER_USERNAME` | The username you have used to register with your Cloud Storage procider |
+| `WHEELHOUSE_UPLOADER_SECRET` | An API key you have obtained from your Cloud Storage provider, which will authenticate you to upload files to it. This should **never** be stored in plain text. To make Appveyor encrypt your API key, use Appveyor's [Encrypt Tool](https://ci.appveyor.com/tools/encrypt) and store the returned value using a `secure:` prefix. |
+
+Maintainers of an official [scikit-learn contrib](
+https://contrib.scikit-learn.org) repository can request [Rackspace]
+(https://mycloud.rackspace.com/) credentials from the scikit-learn developers.
+
+
+### 7. Setting up Circle CI
 The project uses [CircleCI](https://circleci.com/) to build its documentation
 from the `master` branch and host it using [Github Pages](https://pages.github.com/).
 Again,  you will need to Sign Up and authorize CircleCI. The configuration
@@ -157,14 +180,14 @@ on
 https://github.com/USERNAME/DOC_REPO/DOC_URL
 ```
 
-### 7. Adding Badges
+### 8. Adding Badges
 
 Follow the instructions to add a [Travis Badge](https://docs.travis-ci.com/user/status-images/), 
 [Coveralls Badge](https://coveralls.io) and 
 [CircleCI Badge](https://circleci.com/docs/status-badges) to your repository's
 `README`.
 
-### 8. Advertising your package
+### 9. Advertising your package
 
 Once your work is mature enough for the general public to use it, you should
 submit a Pull Request to modify scikit-learn's
@@ -174,7 +197,7 @@ repository or PyPI page.
 You may also wish to announce your work on the
 [`scikit-learn-general` mailing list](https://lists.sourceforge.net/lists/listinfo/scikit-learn-general).
 
-### 9. Uploading your package to PyPI
+### 10. Uploading your package to PyPI
 
 Uploading your package to [PyPI](https://pypi.python.org/pypi) allows users to
 install your package through `pip`. Python provides two repositories to upload

appveyor.yml

@@ -0,0 +1,97 @@
+# AppVeyor.com is a Continuous Integration service to build and run tests under
+# Windows
+
+
+environment:
+  global:
+    # SDK v7.0 MSVC Express 2008's SetEnv.cmd script will fail if the
+    # /E:ON and /V:ON options are not enabled in the batch script interpreter
+    # See: http://stackoverflow.com/a/13751649/163740
+    CMD_IN_ENV: "cmd /E:ON /V:ON /C .\\ci_scripts\\appveyor\\run_with_env.cmd"
+    WHEELHOUSE_UPLOADER_USERNAME: sklearn
+    WHEELHOUSE_UPLOADER_SECRET:
+      secure: XzK+Mi6Ba5frV2B/jHq7h4aD8/nox9SsI3T8Kub1L2XNevRSIurUEry3PdWESzRY
+    MODULE: skltemplate
+    PROJECT_NAME: sklearn-template
+    CLOUD_STORAGE: CLOUDFILES
+    CLOUD_CONTATINER: sklearn-template-trial
+
+  matrix:
+    - PYTHON: "C:\\Python27"
+      PYTHON_VERSION: "2.7.8"
+      PYTHON_ARCH: "32"
+      MINICONDA: "C:\\Miniconda"
+
+    - PYTHON: "C:\\Python27-x64"
+      PYTHON_VERSION: "2.7.8"
+      PYTHON_ARCH: "64"
+      MINICONDA: "C:\\Miniconda-x64"
+
+    - PYTHON: "C:\\Python35"
+      PYTHON_VERSION: "3.5.0"
+      PYTHON_ARCH: "32"
+      MINICONDA: "C:\\Miniconda35"
+
+    - PYTHON: "C:\\Python35-x64"
+      PYTHON_VERSION: "3.5.0"
+      PYTHON_ARCH: "64"
+      MINICONDA: "C:\\Miniconda35-x64"
+
+install:
+  # Miniconda is pre-installed in the worker build
+  - "SET PATH=%MINICONDA%;%MINICONDA%\\Scripts;%PATH%"
+  - "python -m pip install -U pip"
+
+  # Check that we have the expected version and architecture for Python
+  - "python --version"
+  - "python -c \"import struct; print(struct.calcsize('P') * 8)\""
+  - "pip --version"
+
+  # Remove cygwin because it clashes with conda
+  # see http://help.appveyor.com/discussions/problems/3712-git-remote-https-seems-to-be-broken
+  - rmdir C:\\cygwin /s /q
+
+  # Install the build and runtime dependencies of the project.
+  - conda install --quiet --yes numpy scipy cython nose scikit-learn wheel
+  - pip install wheelhouse_uploader nose-timer
+  - "%CMD_IN_ENV% python setup.py bdist_wheel bdist_wininst"
+  - ps: "ls dist"
+
+  # Install the generated wheel package to test it
+  - "pip install --pre --no-index --find-links dist %PROJECT_NAME%"
+
+
+# Not a .NET project, we build scikit-learn in the install step instead
+build: false
+
+
+artifacts:
+  # Archive the generated wheel package in the ci.appveyor.com build report.
+  - path: dist\*
+
+
+on_success:
+  # Upload the generated wheel package to Rackspace
+  # On Windows, Apache Libcloud cannot find a standard CA cert bundle so we
+  # disable the ssl checks.
+  - "python -m wheelhouse_uploader upload provider=%CLOUD_STORAGE% --no-ssl-check --local-folder=dist %CLOUD_CONTAINER%"
+
+
+test_script:
+  # Change to a non-source folder to make sure we run the tests on the
+  # installed library.
+  - "mkdir empty_folder"
+  - "cd empty_folder"
+
+  - "python -c \"import nose; nose.main()\" --with-timer --timer-top-n 20 -s -v %MODULE%"
+
+  # Move back to the project folder
+  - "cd .."
+
+
+cache:
+  # Use the appveyor cache to avoid re-downloading large archives such
+  # the MKL numpy and scipy wheels mirrored on a rackspace cloud
+  # container, speed up the appveyor jobs and reduce bandwidth
+  # usage on our rackspace account.
+  - '%APPDATA%\pip\Cache'

ci_scripts/appveyor/run_with_env.cmd

@@ -0,0 +1,88 @@
+:: To build extensions for 64 bit Python 3, we need to configure environment
+:: variables to use the MSVC 2010 C++ compilers from GRMSDKX_EN_DVD.iso of:
+:: MS Windows SDK for Windows 7 and .NET Framework 4 (SDK v7.1)
+::
+:: To build extensions for 64 bit Python 2, we need to configure environment
+:: variables to use the MSVC 2008 C++ compilers from GRMSDKX_EN_DVD.iso of:
+:: MS Windows SDK for Windows 7 and .NET Framework 3.5 (SDK v7.0)
+::
+:: 32 bit builds, and 64-bit builds for 3.5 and beyond, do not require specific
+:: environment configurations.
+::
+:: Note: this script needs to be run with the /E:ON and /V:ON flags for the
+:: cmd interpreter, at least for (SDK v7.0)
+::
+:: More details at:
+:: https://github.com/cython/cython/wiki/64BitCythonExtensionsOnWindows
+:: http://stackoverflow.com/a/13751649/163740
+::
+:: Author: Olivier Grisel
+:: License: CC0 1.0 Universal: http://creativecommons.org/publicdomain/zero/1.0/
+::
+:: Notes about batch files for Python people:
+::
+:: Quotes in values are literally part of the values:
+::      SET FOO="bar"
+:: FOO is now five characters long: " b a r "
+:: If you don't want quotes, don't include them on the right-hand side.
+::
+:: The CALL lines at the end of this file look redundant, but if you move them
+:: outside of the IF clauses, they do not run properly in the SET_SDK_64==Y
+:: case, I don't know why.
+@ECHO OFF
+
+SET COMMAND_TO_RUN=%*
+SET WIN_SDK_ROOT=C:\Program Files\Microsoft SDKs\Windows
+SET WIN_WDK=c:\Program Files (x86)\Windows Kits\10\Include\wdf
+
+:: Extract the major and minor versions, and allow for the minor version to be
+:: more than 9.  This requires the version number to have two dots in it.
+SET MAJOR_PYTHON_VERSION=%PYTHON_VERSION:~0,1%
+IF "%PYTHON_VERSION:~3,1%" == "." (
+    SET MINOR_PYTHON_VERSION=%PYTHON_VERSION:~2,1%
+) ELSE (
+    SET MINOR_PYTHON_VERSION=%PYTHON_VERSION:~2,2%
+)
+
+:: Based on the Python version, determine what SDK version to use, and whether
+:: to set the SDK for 64-bit.
+IF %MAJOR_PYTHON_VERSION% == 2 (
+    SET WINDOWS_SDK_VERSION="v7.0"
+    SET SET_SDK_64=Y
+) ELSE (
+    IF %MAJOR_PYTHON_VERSION% == 3 (
+        SET WINDOWS_SDK_VERSION="v7.1"
+        IF %MINOR_PYTHON_VERSION% LEQ 4 (
+            SET SET_SDK_64=Y
+        ) ELSE (
+            SET SET_SDK_64=N
+            IF EXIST "%WIN_WDK%" (
+                :: See: https://connect.microsoft.com/VisualStudio/feedback/details/1610302/
+                REN "%WIN_WDK%" 0wdf
+            )
+        )
+    ) ELSE (
+        ECHO Unsupported Python version: "%MAJOR_PYTHON_VERSION%"
+        EXIT 1
+    )
+)
+
+IF %PYTHON_ARCH% == 64 (
+    IF %SET_SDK_64% == Y (
+        ECHO Configuring Windows SDK %WINDOWS_SDK_VERSION% for Python %MAJOR_PYTHON_VERSION% on a 64 bit architecture
+        SET DISTUTILS_USE_SDK=1
+        SET MSSdk=1
+        "%WIN_SDK_ROOT%\%WINDOWS_SDK_VERSION%\Setup\WindowsSdkVer.exe" -q -version:%WINDOWS_SDK_VERSION%
+        "%WIN_SDK_ROOT%\%WINDOWS_SDK_VERSION%\Bin\SetEnv.cmd" /x64 /release
+        ECHO Executing: %COMMAND_TO_RUN%
+        call %COMMAND_TO_RUN% || EXIT 1
+    ) ELSE (
+        ECHO Using default MSVC build environment for 64 bit architecture
+        ECHO Executing: %COMMAND_TO_RUN%
+        call %COMMAND_TO_RUN% || EXIT 1
+    )
+) ELSE (
+    ECHO Using default MSVC build environment for 32 bit architecture
+    ECHO Executing: %COMMAND_TO_RUN%
+    call %COMMAND_TO_RUN% || EXIT 1
+)

circle.yml

@@ -44,7 +44,7 @@ deployment:
   push:
     branch: master
     commands:
-      - bash ci_scripts/push_doc.sh
+      - bash ci_scripts/circleci/push_doc.sh
 general:
   # Open the doc to the API
   artifacts:

setup.cfg

@@ -1,2 +1,25 @@
 [metadata]
-description-file = README.md
+description-file = README.md
+
+[aliases]
+# python2.7 has upgraded unittest and it is no longer compatible with some
+# of our tests, so we run all through nose
+test = nosetests
+
+[nosetests]
+# nosetests skips test files with the executable bit by default
+# which can silently hide failing tests.
+# There are no executable scripts within the scikit-learn project
+# so let's turn the --exe flag on to avoid skipping tests by
+# mistake.
+exe = 1
+cover-html = 1
+cover-html-dir = coverage
+cover-package = sklearn
+
+detailed-errors = 1
+with-doctest = 1
+doctest-tests = 1
+doctest-extension = rst
+doctest-fixtures = _fixture
+ignore-files=^setup\.py$