Merge branch 'master' into unlabelled-readwrite-compatibility

# Conflicts:
#	skll/data/featureset.py

.github/stale.yml

@@ -0,0 +1,16 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 90
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+# Label to use when marking an issue as stale
+staleLabel: stale
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed in 7 days if no further activity occurs.
+  Thank you for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

.travis.yml

@@ -25,7 +25,7 @@ before_install:
   - if [ ${TRAVIS_PYTHON_VERSION:0:1} == "2" ]; then export PATH=/home/travis/miniconda2/bin:$PATH; else export PATH=/home/travis/miniconda3/bin:$PATH; fi
   - conda update --yes conda
 install:
-  - conda install --yes --channel defaults --channel conda-forge python=$TRAVIS_PYTHON_VERSION numpy scipy beautifulsoup4 six scikit-learn==0.19.1 joblib prettytable python-coveralls ruamel.yaml
+  - conda install --yes --channel defaults --channel conda-forge python=$TRAVIS_PYTHON_VERSION numpy scipy beautifulsoup4 six scikit-learn==0.20.1 joblib prettytable python-coveralls ruamel.yaml
   - if [ ${TRAVIS_PYTHON_VERSION:0:1} == "2" ]; then conda install --yes --channel defaults configparser mock; fi
   - if [ ${WITH_PANDAS_AND_SEABORN} == "true" ]; then conda install --yes --channel defaults pandas seaborn; fi
   # Have to use pip for nose-cov because its entry points are not supported by conda yet

CONTRIBUTING.md

@@ -114,5 +114,10 @@ documentation without the example gallery. 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/).
+For building the documentation, you will need [sphinx](http://sphinx.pocoo.org/) as well as the readthedocs sphinx theme. To install both, just run:
+
+      conda install sphinx sphinx_rtd_theme
+
+in your existing conda environment.
+
 

README.rst

@@ -124,17 +124,17 @@ Requirements
 
 -  Python 2.7+
 -  `scikit-learn <http://scikit-learn.org/stable/>`__
--  `six <https://warehouse.python.org/project/six>`__
--  `PrettyTable <https://warehouse.python.org/project/PrettyTable>`__
+-  `six <https://pypi.org/project/six/>`__
+-  `PrettyTable <https://pypi.org/project/PrettyTable/>`__
 -  `BeautifulSoup 4 <http://www.crummy.com/software/BeautifulSoup/>`__
--  `Grid Map <https://warehouse.python.org/project/gridmap>`__ (only required if you plan
+-  `Grid Map <https://pypi.org/project/gridmap/>`__ (only required if you plan
    to run things in parallel on a DRMAA-compatible cluster)
--  `joblib <https://warehouse.python.org/project/joblib>`__
+-  `joblib <https://pypi.org/project/joblib/>`__
 -  `ruamel.yaml <http://yaml.readthedocs.io/en/latest/overview.html>`__
--  `configparser <https://warehouse.python.org/project/configparser>`__ (only required for
+-  `configparser <https://pypi.org/project/configparser/>`__ (only required for
    Python 2.7)
--  `logutils <https://warehouse.python.org/project/logutils>`__ (only required for Python 2.7)
--  `mock <https://warehouse.python.org/project/mock>`__ (only required for Python 2.7)
+-  `logutils <https://pypi.org/project/logutils/>`__ (only required for Python 2.7)
+-  `mock <https://pypi.org/project/mock/>`__ (only required for Python 2.7)
 
 The following packages can be optionally installed for additional features
 but are not required:

conda-recipe/README.md

@@ -1,7 +1,7 @@
 How to create and test conda package.
 
 1. To create the SKLL conda package run:
-   `conda build -c defaults -c conda-forge --python=3.6 --numpy=1.13 skll`
+   `conda build -c defaults -c conda-forge --python=3.6 --numpy=1.14 skll`
 2. Upload the package to anaconda.org using `anaconda upload <path>`.
 3. Test the package:
    `conda create -n foobar -c defaults -c conda-forge -c desilinguist python=3.6 skll=1.5`

conda-recipe/skll/meta.yaml

@@ -1,6 +1,6 @@
 package:
   name: skll
-  version: 1.5
+  version: 1.5.3
 
 source:
   path: ../../../skll
@@ -42,7 +42,7 @@ build:
 requirements:
   build:
     - python
-    - scikit-learn ==0.19.1
+    - scikit-learn ==0.20.1
     - joblib >=0.8
     - setuptools
     - six
@@ -57,7 +57,7 @@ requirements:
 
   run:
     - python
-    - scikit-learn ==0.19.1
+    - scikit-learn ==0.20.1
     - joblib >=0.8
     - six
     - prettytable

conda_requirements.txt

@@ -1,4 +1,4 @@
-scikit-learn==0.19.1
+scikit-learn==0.20.1
 six
 PrettyTable
 beautifulsoup4

doc/getting_started.rst

@@ -11,7 +11,7 @@ or via ``conda`` (only for Python 3.6)::
     conda install -c defaults -c conda-forge -c desilinguist python=3.6 skll
 
 It can also be downloaded directly from
-`GitHub <http://github.com/EducationalTestingService/skll>`_.
+`GitHub <https://github.com/EducationalTestingService/skll>`_.
 
 
 License

doc/index.rst

@@ -30,6 +30,7 @@ Documentation
    run_experiment
    utilities
    api
+   internal
 
 
 Indices and tables

doc/internal.rst

@@ -0,0 +1,7 @@
+Internal Documentation
+======================
+
+.. toctree::
+   :maxdepth: 4
+
+   internal/release

doc/internal/release.rst

@@ -0,0 +1,42 @@
+Release Process
+===============
+
+This document is only meant for the project administrators, not users and developers.
+
+1. Create a release branch on GitHub.
+
+2. In the release branch:
+
+   a. update the version numbers in ``version.py``.
+
+   b. update the conda recipe.
+
+   c. update the documentation with any new features or details about changes.
+
+   d. run ``make linkcheck`` on the documentation and fix any redirected/broken links.
+
+   e. update the README.
+
+3. Build the new conda package locally on your mac using the following command  (*Note*: you may have to replace the contents of the ``requirements()`` function in ``setup.py`` with a ``pass`` statement to get ``conda build`` to work)::
+
+    conda build -c defaults -c conda-forge --python=3.6 --numpy=1.14 skll
+
+4. Convert the package for both linux and windows::
+
+    conda convert -p win-64 -p linux-64 <mac package tarball>
+
+5. Upload each of the packages to anaconda.org using ``anaconda upload <package tarball>``.
+
+6. Upload source package to PyPI using ``python setup.py sdist upload``.
+
+7. Draft a release on GitHub.
+
+8. Make a pull request with the release branch to be merged into ``master`` and request code review.
+
+9. Once the build for the PR passes and the reviewers approve, merge the release branch into ``master``.
+
+10. Make sure that the RTFD build for ``master`` passes.
+
+11. Tag the latest commit in ``master`` with the appropriate release tag and publish the release on GitHub.
+
+12. Send an email around at ETS announcing the release and the changes.