Prepare new release

.gitignore

@@ -1,3 +1,4 @@
+*~
 doc/generated
 examples/.ipynb_checkpoints
 # Byte-compiled / optimized / DLL files

CONTRIBUTING.md

@@ -0,0 +1,178 @@
+How to contribute
+-----------------
+
+The preferred workflow for contributing to the OpenML python connector is to
+fork the [main repository](https://github.com/openml/openml-python) on
+GitHub, clone, check out the branch `develop`, and develop on a new branch
+branch. Steps:
+
+1. Fork the [project repository](https://github.com/openml/openml-python)
+   by clicking on the 'Fork' button near the top right of the page. This creates
+   a copy of the code under your GitHub user account. For more details on
+   how to fork a repository see [this guide](https://help.github.com/articles/fork-a-repo/).
+
+2. Clone your fork of the openml-python repo from your GitHub account to your
+local disk:
+
+   ```bash
+   $ git clone git@github.com:YourLogin/openml-python.git
+   $ cd openml-python
+   ```
+
+3. Swith to the ``develop`` branch:
+
+   ```bash
+   $ git checkout develop
+   ```
+
+3. Create a ``feature`` branch to hold your development changes:
+
+   ```bash
+   $ git checkout -b feature/my-feature
+   ```
+
+   Always use a ``feature`` branch. It's good practice to never work on the ``master`` or ``develop`` branch! To make the nature of your pull request easily visible, please perpend the name of the branch with the type of changes you want to merge, such as ``feature`` if it contains a new feature, ``fix`` for a bugfix, ``doc`` for documentation and ``maint`` for other maintenance on the package.
+
+4. Develop the feature on your feature branch. Add changed files using ``git add`` and then ``git commit`` files:
+
+   ```bash
+   $ git add modified_files
+   $ git commit
+   ```
+
+   to record your changes in Git, then push the changes to your GitHub account with:
+
+   ```bash
+   $ git push -u origin my-feature
+   ```
+
+5. Follow [these instructions](https://help.github.com/articles/creating-a-pull-request-from-a-fork)
+to create a pull request from your fork. This will send an email to the committers.
+
+(If any of the above seems like magic to you, please look up the
+[Git documentation](https://git-scm.com/documentation) on the web, or ask a friend or another contributor for help.)
+
+Pull Request Checklist
+----------------------
+
+We recommended that your contribution complies with the
+following rules before you submit a pull request:
+
+-  Follow the
+   [pep8 style guilde](https://www.python.org/dev/peps/pep-0008/).
+
+-  If your pull request addresses an issue, please use the pull request title
+   to describe the issue and mention the issue number in the pull request description. This will make sure a link back to the original issue is
+   created.
+
+-  An incomplete contribution -- where you expect to do more work before
+   receiving a full review -- should be prefixed `[WIP]` (to indicate a work
+   in progress) and changed to `[MRG]` when it matures. WIPs may be useful
+   to: indicate you are working on something to avoid duplicated work,
+   request broad review of functionality or API, or seek collaborators.
+   WIPs often benefit from the inclusion of a
+   [task list](https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments)
+   in the PR description.
+
+-  All tests pass when running `nosetests`. On
+   Unix-like systems, check with (from the toplevel source folder):
+
+      ```bash
+      $ nosetests
+      ```
+
+   For Windows systems, execute the command from an Anaconda Prompt or add `nosetests` to PATH before executing the command.
+
+-  Documentation and high-coverage tests are necessary for enhancements to be
+   accepted. Bug-fixes or new features should be provided with
+   [non-regression tests](https://en.wikipedia.org/wiki/Non-regression_testing).
+   These tests verify the correct behavior of the fix or feature. In this
+   manner, further modifications on the code base are granted to be consistent
+   with the desired behavior.
+   For the Bug-fixes case, at the time of the PR, this tests should fail for
+   the code base in develop and pass for the PR code.
+
+
+You can also check for common programming errors with the following
+tools:
+
+-  Code with good unittest **coverage** (at least 80%), check with:
+
+  ```bash
+  $ pip install nose coverage
+  $ nosetests --with-coverage path/to/tests_for_package
+  ```
+
+-  No pyflakes warnings, check with:
+
+  ```bash
+  $ pip install pyflakes
+  $ pyflakes path/to/module.py
+  ```
+
+-  No PEP8 warnings, check with:
+
+  ```bash
+  $ pip install pep8
+  $ pep8 path/to/module.py
+  ```
+
+Filing bugs
+-----------
+We use GitHub issues to track all bugs and feature requests; feel free to
+open an issue if you have found a bug or wish to see a feature implemented.
+
+It is recommended to check that your issue complies with the
+following rules before submitting:
+
+-  Verify that your issue is not being currently addressed by other
+   [issues](https://github.com/openml/openml-python/issues)
+   or [pull requests](https://github.com/openml/openml-python/pulls).
+
+-  Please ensure all code snippets and error messages are formatted in
+   appropriate code blocks.
+   See [Creating and highlighting code blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks).
+
+-  Please include your operating system type and version number, as well
+   as your Python, openml, scikit-learn, numpy, and scipy versions. This information
+   can be found by running the following code snippet:
+
+  ```python
+  import platform; print(platform.platform())
+  import sys; print("Python", sys.version)
+  import numpy; print("NumPy", numpy.__version__)
+  import scipy; print("SciPy", scipy.__version__)
+  import sklearn; print("Scikit-Learn", sklearn.__version__)
+  import openml; print("OpenML", openml.__version__)
+  ```
+
+New contributor tips
+--------------------
+
+A great way to start contributing to scikit-learn is to pick an item
+from the list of [Easy issues](https://github.com/openml/openml-python/issues?q=label%3Aeasy)
+in the issue tracker. Resolving these issues allow you to start
+contributing to the project without much prior knowledge. Your
+assistance in this area will be greatly appreciated by the more
+experienced developers as it helps free up their time to concentrate on
+other issues.
+
+Documentation
+-------------
+
+We are glad to accept any sort of documentation: function docstrings,
+reStructuredText documents (like this one), tutorials, etc.
+reStructuredText documents live in the source code repository under the
+doc/ directory.
+
+You can edit the documentation using any text editor and then generate
+the HTML output by typing ``make html`` from the doc/ directory.
+The resulting HTML files will be placed in ``build/html/`` and are viewable in
+a web browser. See the ``README`` file in the ``doc/`` directory for more
+information.
+
+For building the documentation, you will need
+[sphinx](http://sphinx.pocoo.org/),
+[matplotlib](http://matplotlib.org/), and
+[pillow](http://pillow.readthedocs.io/en/latest/).
+[sphinx-bootstrap-theme](https://ryan-roemer.github.io/sphinx-bootstrap-theme/)

ISSUE_TEMPLATE.md

@@ -0,0 +1,33 @@
+#### Description
+<!-- Example: Joblib Error thrown when calling fit on LatentDirichletAllocation with evaluate_every > 0-->
+
+#### Steps/Code to Reproduce
+<!--
+Example:
+```python
+import openml
+openml.flows.get_flow(1)
+```
+If the code is too long, feel free to put it in a public gist and link
+it in the issue: https://gist.github.com
+-->
+
+#### Expected Results
+<!-- Example: No error is thrown. Please paste or describe the expected results.-->
+
+#### Actual Results
+<!-- Please paste or specifically describe the actual output or traceback. -->
+
+#### Versions
+<!--
+Please run the following snippet and paste the output below.
+import platform; print(platform.platform())
+import sys; print("Python", sys.version)
+import numpy; print("NumPy", numpy.__version__)
+import scipy; print("SciPy", scipy.__version__)
+import sklearn; print("Scikit-Learn", sklearn.__version__)
+import openml; print("OpenML", openml.__version__)
+-->
+
+
+<!-- Thanks for contributing! -->

LICENSE

@@ -0,0 +1,68 @@
+BSD 3-Clause License
+
+Copyright (c) 2014-2018, Matthias Feurer, Jan van Rijn, Andreas Müller, 
+Joaquin Vanschoren and others.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+License of the files CONTRIBUTING.md, ISSUE_TEMPLATE.md and 
+PULL_REQUEST_TEMPLATE.md:
+
+Those files are modifications of the respecting templates in scikit-learn and
+they are licensed under a New BSD license:
+
+New BSD License
+
+Copyright (c) 2007–2018 The scikit-learn developers.
+All rights reserved.
+
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+  a. Redistributions of source code must retain the above copyright notice,
+     this list of conditions and the following disclaimer.
+  b. Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in the
+     documentation and/or other materials provided with the distribution.
+  c. Neither the name of the Scikit-learn Developers  nor the names of
+     its contributors may be used to endorse or promote products
+     derived from this software without specific prior written
+     permission. 
+
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGE.

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,21 @@
+<!--
+Thanks for contributing a pull request to the OpenML python connector! Please ensure you have taken a look at
+the contribution guidelines: https://github.com/openml/openml-python/blob/master/CONTRIBUTING.md#Contributing-Pull-Requests
+
+Please make sure that:
+
+* this pull requests is against the `develop` branch
+* you updated all docs
+-->
+#### Reference Issue
+<!-- Example: Fixes #1234 -->
+
+
+#### What does this PR implement/fix? Explain your changes.
+
+
+#### How should this PR be tested?
+
+
+#### Any other comments?
+

appveyor.yml

@@ -0,0 +1,52 @@
+
+environment:
+ global:
+     CMD_IN_ENV: "cmd /E:ON /V:ON /C .\\appveyor\\scikit-learn-contrib\\run_with_env.cmd"
+
+ matrix:
+    - PYTHON: "C:\\Python35-x64"
+      PYTHON_VERSION: "3.5"
+      PYTHON_ARCH: "64"
+      MINICONDA: "C:\\Miniconda35-x64"
+
+    - PYTHON: "C:\\Python35"
+      PYTHON_VERSION: "3.5"
+      PYTHON_ARCH: "32"
+      MINICONDA: "C:\\Miniconda35"
+
+matrix:
+    fast_finish: true
+
+
+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
+
+  # Update previous packages and install the build and runtime dependencies of the project.
+  # XXX: setuptools>23 is currently broken on Win+py3 with numpy
+  # (https://github.com/pypa/setuptools/issues/728)
+  - conda update --all --yes setuptools=23
+
+  # Install the build and runtime dependencies of the project.
+  - "cd C:\\projects\\openml-python"
+  - conda install --quiet --yes mock numpy scipy nose requests scikit-learn nbformat python-dateutil nbconvert
+  - pip install liac-arff xmltodict oslo.concurrency
+  - "%CMD_IN_ENV% python setup.py install"
+
+
+# Not a .NET project, we build scikit-learn in the install step instead
+build: false
+
+test_script:
+  - "cd C:\\projects\\openml-python"
+  - "%CMD_IN_ENV% python setup.py test"