merging

Author: William de Vazelhes

.codecov.yml

@@ -0,0 +1,24 @@
+# taken from scikit-learn:
+# https://github.com/scikit-learn/scikit-learn/blob/a7e17117bb15eb3f51ebccc1bd53e42fcb4e6cd8/.codecov.yml
+comment: false
+
+coverage:
+  status:
+    project:
+      default:
+        # Commits pushed to master should not make the overall
+        # project coverage decrease by more than 1%:
+        target: auto
+        threshold: 1%
+    patch:
+      default:
+        # Be tolerant on slight code coverage diff on PRs to limit
+        # noisy red coverage status on github PRs.
+        # Note The coverage stats are still uploaded
+        # to codecov so that PR reviewers can see uncovered lines
+        # in the github diff if they install the codecov browser
+        # extension:
+        # https://github.com/codecov/browser-extension
+        target: auto
+        threshold: 1%
+

.gitignore

@@ -5,4 +5,8 @@ dist/
 .coverage
 htmlcov/
 .cache/
+.pytest_cache/
 doc/auto_examples/*
+coverage
+.coverage
+.coverage*

.travis.yml

@@ -9,9 +9,19 @@ before_install:
   - sudo apt-get install liblapack-dev
   - pip install --upgrade pip
   - pip install wheel
-  - pip install cython numpy scipy scikit-learn
+  - pip install cython numpy scipy scikit-learn codecov
   - if [[ ($TRAVIS_PYTHON_VERSION == "3.6") ||
           ($TRAVIS_PYTHON_VERSION == "2.7")]]; then
               pip install git+https://github.com/skggm/skggm.git@a0ed406586c4364ea3297a658f415e13b5cbdaf8;
     fi
-script: pytest test
+  - if [[ $TRAVIS_PYTHON_VERSION == "3.4" ]];
+    then pip install pytest-cov pytest==3.6;
+    fi
+script:
+  - if [[ $TRAVIS_PYTHON_VERSION == "3.4" ]];
+    then pytest test --cov;
+    else pytest test;
+    fi
+after_success:
+  - bash <(curl -s https://codecov.io/bash)
+

README.rst

@@ -1,4 +1,4 @@
-|Travis-CI Build Status| |License| |PyPI version|
+|Travis-CI Build Status| |License| |PyPI version| |Code coverage|
 
 metric-learn
 =============
@@ -52,4 +52,5 @@ more complete.
    :target: http://badges.mit-license.org
 .. |PyPI version| image:: https://badge.fury.io/py/metric-learn.svg
    :target: http://badge.fury.io/py/metric-learn
-
+.. |Code coverage| image:: https://codecov.io/gh/metric-learn/metric-learn/branch/master/graph/badge.svg
+   :target: https://codecov.io/gh/metric-learn/metric-learn

doc/conf.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+import sys
 
 extensions = [
     'sphinx.ext.autodoc',
@@ -8,7 +9,8 @@
     'sphinx.ext.mathjax',
     'numpydoc',
     'sphinx_gallery.gen_gallery',
-    'sphinx.ext.doctest'
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx'
 ]
 
 templates_path = ['_templates']
@@ -39,3 +41,12 @@
 # Option to hide doctests comments in the documentation (like # doctest:
 # +NORMALIZE_WHITESPACE for instance)
 trim_doctest_flags = True
+
+# intersphinx configuration
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/{.major}'.format(
+        sys.version_info), None),
+    'numpy': ('https://docs.scipy.org/doc/numpy/', None),
+    'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
+    'scikit-learn': ('https://scikit-learn.org/stable/', None)
+}

doc/index.rst

@@ -1,6 +1,6 @@
 metric-learn: Metric Learning in Python
 =======================================
-|License| |PyPI version|
+|Travis-CI Build Status| |License| |PyPI version| |Code coverage|
 
 Metric-learn contains efficient Python implementations of several
 popular supervised and weakly-supervised metric learning algorithms. The API
@@ -34,7 +34,11 @@ Documentation outline
 
 :ref:`genindex` | :ref:`modindex` | :ref:`search`
 
+.. |Travis-CI Build Status| image:: https://api.travis-ci.org/metric-learn/metric-learn.svg?branch=master
+   :target: https://travis-ci.org/metric-learn/metric-learn
 .. |PyPI version| image:: https://badge.fury.io/py/metric-learn.svg
    :target: http://badge.fury.io/py/metric-learn
 .. |License| image:: http://img.shields.io/:license-mit-blue.svg?style=flat
    :target: http://badges.mit-license.org
+.. |Code coverage| image:: https://codecov.io/gh/metric-learn/metric-learn/branch/master/graph/badge.svg
+   :target: https://codecov.io/gh/metric-learn/metric-learn