Merge branch 'master' into Issue35-documentation

Author: ianhi

.all-contributorsrc

@@ -39,7 +39,8 @@
       "profile": "https://sjhaque14.wixsite.com/sjhaque",
       "contributions": [
         "doc",
-        "userTesting"
+        "userTesting",
+        "code"
       ]
     }
   ],

.github/workflows/test.yml

@@ -0,0 +1,58 @@
+name: Test
+
+# this is heavily based off the jupyterlab-git workflow file created by @fcollonval
+# https://github.com/jupyterlab/jupyterlab-git/blob/a046b66415c6afabcbdf6e624e2a367523ee2e80/.github/workflows/build.yml
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test-3x:
+    name: Python ${{ matrix.python-version }} - Matplotlib ${{ matrix.matplotlib-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.7', '3.8']
+        matplotlib-version: ['3.2', '3.3']
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: 'x64'
+
+      - name: Get pip cache dir
+        id: pip-cache
+        run: |
+          echo "::set-output name=dir::$(pip cache dir)"
+  
+      - name: pip cache
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('**/setup.py') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-${{ matrix.python-version }}-
+            ${{ runner.os }}-pip-
+
+      - name: Install
+        run: |
+          pip install wheel
+          pip install matplotlib==${{ matrix.matplotlib-version}}.*
+          pip install .[test]
+
+      - name: Check Formatting
+        run: |
+          black mpl_interactions --check
+          black examples --check
+
+      - name: Tests
+        run: |
+          pytest --color=yes
+

.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 20.8b1 # Replace by any tag/version: https://github.com/psf/black/tags
+    hooks:
+      - id: black
+        language_version: python3 # Should be a command that runs python3.6+

README.md

@@ -111,7 +111,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="http://ianhi.github.io"><img src="https://avatars0.githubusercontent.com/u/10111092?v=4" width="100px;" alt=""/><br /><sub><b>Ian Hunt-Isaak</b></sub></a><br /><a href="https://github.com/ianhi/mpl-interactions/commits?author=ianhi" title="Code">💻</a></td>
     <td align="center"><a href="https://darlingdocs.wordpress.com/"><img src="https://avatars1.githubusercontent.com/u/67113216?v=4" width="100px;" alt=""/><br /><sub><b>Sam</b></sub></a><br /><a href="https://github.com/ianhi/mpl-interactions/commits?author=samanthahamilton" title="Documentation">📖</a></td>
     <td align="center"><a href="https://github.com/jcoulter12"><img src="https://avatars1.githubusercontent.com/u/14036348?v=4" width="100px;" alt=""/><br /><sub><b>Jenny Coulter</b></sub></a><br /><a href="#userTesting-jcoulter12" title="User Testing">📓</a></td>
-    <td align="center"><a href="https://sjhaque14.wixsite.com/sjhaque"><img src="https://avatars3.githubusercontent.com/u/61242473?v=4" width="100px;" alt=""/><br /><sub><b>Sabina Haque</b></sub></a><br /><a href="https://github.com/ianhi/mpl-interactions/commits?author=sjhaque14" title="Documentation">📖</a> <a href="#userTesting-sjhaque14" title="User Testing">📓</a></td>
+    <td align="center"><a href="https://sjhaque14.wixsite.com/sjhaque"><img src="https://avatars3.githubusercontent.com/u/61242473?v=4" width="100px;" alt=""/><br /><sub><b>Sabina Haque</b></sub></a><br /><a href="https://github.com/ianhi/mpl-interactions/commits?author=sjhaque14" title="Documentation">📖</a> <a href="#userTesting-sjhaque14" title="User Testing">📓</a> <a href="https://github.com/ianhi/mpl-interactions/commits?author=sjhaque14" title="Code">💻</a></td>
   </tr>
 </table>
 

docs/API.rst

@@ -18,6 +18,8 @@ will use the built-in Matplotlib widgets.
    ~mpl_interactions.interactive_plot
    ~mpl_interactions.interactive_plot_factory
    ~mpl_interactions.interactive_hist
+   ~mpl_interactions.interactive_scatter
+   ~mpl_interactions.interactive_imshow
 
 
 generic

docs/Contributing.rst

@@ -11,6 +11,19 @@ Code Improvements
 
 All development for this library happens on Github at `mpl_interactions <https://github.com/ianhi/mpl-interactions>`_.
 
+.. code-block:: bash
+   
+   git clone <your fork>
+   cd mpl-interactions
+   pip install -e ".[dev, doc, test]"
+   pre-commit install
+
+.. code-block:: bash
+
+   conda install nodejs=12
+   jupyter labextension install @jupyter-widgets/jupyterlab-manager
+
+
 Seeing your changes
 ^^^^^^^^^^^^^^^^^^^
 
@@ -45,7 +58,7 @@ Following changes to the source files, you can view recent adjustments by buildi
 .. code-block:: bash
 
     cd mpl-interactions
-    pip install -e.[docs]
+    pip install -e ".[doc]"
 
 2. Run the following commands:
 

docs/Installation.rst

@@ -34,4 +34,4 @@ First create your own fork of https://github.com/ianhi/mpl-interactions.
    
    git clone <your fork>
    cd mpl-interactions
-   pip install -e.[docs]
+   pip install -e ".[dev, doc, test]"

docs/Makefile

@@ -20,4 +20,4 @@ help:
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 watch:
-	sphinx-autobuild . _build/html -B
+	sphinx-autobuild . _build/html --open-browser

docs/conf.py

@@ -12,7 +12,8 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../mpl_interactions'))
+
+sys.path.insert(0, os.path.abspath("../mpl_interactions"))
 import mpl_interactions as mpl_inter
 
 release = mpl_inter.__version__
@@ -22,9 +23,9 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'mpl-interactions'
-copyright = '2020, Ian Hunt-Isaak'
-author = 'Ian Hunt-Isaak'
+project = "mpl-interactions"
+copyright = "2020, Ian Hunt-Isaak"
+author = "Ian Hunt-Isaak"
 
 # The full version, including alpha/beta/rc tags
 
@@ -35,16 +36,13 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    #'sphinx.ext.autodoc',
-    #'sphinx.ext.autosummary',
-    'nbsphinx',
-    'sphinx.ext.mathjax',
-    'sphinx.ext.linkcode',
-    'sphinx.ext.napoleon',
-    'numpydoc',
-    'jupyter_sphinx',
-    'sphinx_copybutton',
-    ]
+    "sphinx.ext.mathjax",
+    "sphinx.ext.linkcode",
+    "sphinx.ext.napoleon",
+    "numpydoc",
+    "jupyter_sphinx",
+    "sphinx_copybutton",
+]
 
 
 napoleon_google_docstring = False
@@ -57,49 +55,45 @@
 napoleon_use_ivar = False
 napoleon_use_param = False
 napoleon_use_rtype = False
-add_module_names=False
+add_module_names = False
 
 autosummary_generate = True
 autodoc_default_options = {
-   'members':True,
-   'show-inheritance':True,
+    "members": True,
+    "show-inheritance": True,
 }
-nbsphinx_execute = 'always'
-nbsphinx_execute_arguments = [
-    "--InlineBackend.figure_formats={'svg', 'pdf'}",
-    "--InlineBackend.rc={'figure.dpi': 96}",
-]
+
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '**ipynb_checkpoints']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**ipynb_checkpoints"]
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 html_theme_options = {
-        # Toc options
-        'collapse_navigation': False,
-        'sticky_navigation': True,
-        'navigation_depth': 4,
+    # Toc options
+    "collapse_navigation": False,
+    "sticky_navigation": True,
+    "navigation_depth": 4,
 }
 
 
-master_doc = 'index'
+master_doc = "index"
 
 
 def setup(app):

docs/examples/mpl-sliders.rst

@@ -9,6 +9,7 @@ Using Matplotlib Widgets
 This page is dedicated to showing how to use the ``interactive_*`` functions---such as ``interactive_plot``---with Matplotlib widgets. For
 a more general discussion of how to use the ``pyplot`` submodule see the :doc:`pyplot-notebooks` page.
 
+
 Differences from ipywidgets sliders
 -----------------------------------
 **1.** mpl-sliders are different from ipywidgets sliders in that they will only take a min and and max with