Added PEP 561 compliance (#945) (#946)

* Added PEP 561 compliance (#945)

* FIX: mypy test dependancy

* FIX: mypy test dependancy (#945)

* FIX: Added mypy to CI list of test packages

Author: eddiebergman

ci_scripts/install.sh

@@ -38,7 +38,7 @@ python --version
 
 if [[ "$TEST_DIST" == "true" ]]; then
     pip install twine nbconvert jupyter_client matplotlib pyarrow pytest pytest-xdist pytest-timeout \
-        nbformat oslo.concurrency flaky
+        nbformat oslo.concurrency flaky mypy
     python setup.py sdist
     # Find file which was modified last as done in https://stackoverflow.com/a/4561987
     dist=`find dist -type f -printf '%T@ %p\n' | sort -n | tail -1 | cut -f2- -d" "`
@@ -52,6 +52,7 @@ fi
 python -c "import numpy; print('numpy %s' % numpy.__version__)"
 python -c "import scipy; print('scipy %s' % scipy.__version__)"
 
+
 if [[ "$DOCPUSH" == "true" ]]; then
     conda install --yes gxx_linux-64 gcc_linux-64 swig
     pip install -e '.[examples,examples_unix]'
@@ -64,6 +65,15 @@ if [[ "$RUN_FLAKE8" == "true" ]]; then
     pre-commit install
 fi
 
+# PEP 561 compliance check
+# Assumes mypy relies solely on the PEP 561 standard
+if ! python -m mypy -c "import openml"; then
+   echo "Failed: PEP 561 compliance"
+   exit 1
+else
+   echo "Success: PEP 561 compliant"
+fi
+
 # Install scikit-learn last to make sure the openml package installation works
 # from a clean environment without scikit-learn.
 pip install scikit-learn==$SKLEARN_VERSION

doc/progress.rst

@@ -18,6 +18,7 @@ Changelog
 * MAINT #865: OpenML no longer bundles test files in the source distribution.
 * MAINT #897: Dropping support for Python 3.5.
 * ADD #894: Support caching of datasets using feather format as an option.
+* ADD #945: PEP 561 compliance for distributing Type information
 
 0.10.2
 ~~~~~~

openml/py.typed

@@ -42,7 +42,7 @@
     packages=setuptools.find_packages(
         include=["openml.*", "openml"], exclude=["*.tests", "*.tests.*", "tests.*", "tests"],
     ),
-    package_data={"": ["*.txt", "*.md"]},
+    package_data={"": ["*.txt", "*.md", "py.typed"]},
     python_requires=">=3.6",
     install_requires=[
         "liac-arff>=2.4.0",
@@ -68,6 +68,7 @@
             "pyarrow",
             "pre-commit",
             "pytest-cov",
+            "mypy",
         ],
         "examples": [
             "matplotlib",