mpl-interactions


Namempl-interactions JSON
Version 0.23.2 PyPI version JSON
download
home_page
SummaryMatplotlib aware interact functions
upload_time2023-09-04 20:17:20
maintainer
docs_urlNone
authorIan Hunt-Isaak
requires_python>=3.6
licenseBSD
keywords ipython jupyter matplotlib widgets
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # mpl_interactions

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

[![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors-)

<!-- ALL-CONTRIBUTORS-BADGE:END -->

[![PyPI package](https://badge.fury.io/py/mpl-interactions.svg)](https://pypi.org/project/mpl-interactions)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/mpl-interactions)](https://pypi.org/project/mpl-interactions)
[![Documentation Status](https://readthedocs.org/projects/mpl-interactions/badge/?version=stable)](https://mpl-interactions.readthedocs.io/en/stable/?badge=stable)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ianhi/mpl-interactions/master?urlpath=lab)
[![Test](https://github.com/ianhi/mpl-interactions/actions/workflows/test.yml/badge.svg)](https://github.com/ianhi/mpl-interactions/actions/workflows/test.yml)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ianhi/mpl-interactions/master.svg)](https://results.pre-commit.ci/latest/github/ianhi/mpl-interactions/master)
[![Code style: Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://prettier.io)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort)

## Welcome!

mpl_interactions' library provides helpful ways to interact with [Matplotlib](https://matplotlib.org/) plots. Full narrative documentation and example can be found on [Read the Docs](https://mpl-interactions.readthedocs.io).

<img src=https://raw.githubusercontent.com/ianhi/mpl-interactions/master/docs/_static/images/short-interactive.gif width=45%> <img src=https://raw.githubusercontent.com/ianhi/mpl-interactions/master/docs/_static/images/heatmap_slicer.gif width=45%>

## Installation

```bash
pip install mpl_interactions["jupyter"] # will install necessary deps for using in jupyter

# for use only outside of jupyter:
pip install mpl_interactions
```

If you use JupyterLab, make sure you follow the full instructions in the ipympl [readme](https://github.com/matplotlib/ipympl#install-the-jupyterlab-extension) in particular installing jupyterlab-manager.

## Contributing / feature requests / roadmap

I use the GitHub [issues](https://github.com/ianhi/mpl-interactions/issues) to keep track of ideas I have, so looking through those should serve as a roadmap of sorts. For the most part I add to the library when I create a function that is useful for the science I am doing. If you create something that seems useful a PR would be most welcome so we can share it easily with more people. I'm also open to feature requests if you have an idea.

## Documentation

The fuller narrative documentation can be found on [ReadTheDocs](https://mpl-interactions.readthedocs.io/en/latest/). You may also find it helpful to check out the [examples directory](docs/examples).

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tr>
    <td align="center"><a href="http://ianhi.github.io"><img src="https://avatars0.githubusercontent.com/u/10111092?v=4?s=100" 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?s=100" 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?s=100" 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?s=100" 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>
    <td align="center"><a href="https://github.com/jrussell25"><img src="https://avatars2.githubusercontent.com/u/35578729?v=4?s=100" width="100px;" alt=""/><br /><sub><b>John Russell</b></sub></a><br /><a href="https://github.com/ianhi/mpl-interactions/commits?author=jrussell25" title="Code">💻</a> <a href="#userTesting-jrussell25" title="User Testing">📓</a> <a href="https://github.com/ianhi/mpl-interactions/commits?author=jrussell25" title="Documentation">📖</a></td>
    <td align="center"><a href="http://maxshinnpotential.com"><img src="https://avatars2.githubusercontent.com/u/951986?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Max Shinn</b></sub></a><br /><a href="https://github.com/ianhi/mpl-interactions/commits?author=mwshinn" title="Code">💻</a> <a href="#userTesting-mwshinn" title="User Testing">📓</a></td>
    <td align="center"><a href="https://github.com/kmdalton"><img src="https://avatars2.githubusercontent.com/u/2790777?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Kevin Dalton</b></sub></a><br /><a href="#userTesting-kmdalton" title="User Testing">📓</a></td>
  </tr>
  <tr>
    <td align="center"><a href="https://github.com/redeboer"><img src="https://avatars.githubusercontent.com/u/29308176?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Remco de Boer</b></sub></a><br /><a href="https://github.com/ianhi/mpl-interactions/commits?author=redeboer" title="Code">💻</a> <a href="#userTesting-redeboer" title="User Testing">📓</a> <a href="https://github.com/ianhi/mpl-interactions/commits?author=redeboer" title="Documentation">📖</a></td>
    <td align="center"><a href="https://github.com/samwelborn"><img src="https://avatars.githubusercontent.com/u/55868530?v=4?s=100" width="100px;" alt=""/><br /><sub><b>samwelborn</b></sub></a><br /><a href="#userTesting-samwelborn" title="User Testing">📓</a></td>
    <td align="center"><a href="http://www.matthewfeickert.com/"><img src="https://avatars.githubusercontent.com/u/5142394?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Matthew Feickert</b></sub></a><br /><a href="https://github.com/ianhi/mpl-interactions/commits?author=matthewfeickert" title="Code">💻</a></td>
  </tr>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "mpl-interactions",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "ianhuntisaak@gmail.com",
    "keywords": "IPython,Jupyter,Matplotlib,Widgets",
    "author": "Ian Hunt-Isaak",
    "author_email": "ianhuntisaak@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/bd/50/b6a98cd1ae60634b28c1054793a52b6da2b9f00c166ed31a9b3312a0f08f/mpl_interactions-0.23.2.tar.gz",
    "platform": "Linux",
    "description": "# mpl_interactions\n\n<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->\n\n[![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors-)\n\n<!-- ALL-CONTRIBUTORS-BADGE:END -->\n\n[![PyPI package](https://badge.fury.io/py/mpl-interactions.svg)](https://pypi.org/project/mpl-interactions)\n[![Supported Python versions](https://img.shields.io/pypi/pyversions/mpl-interactions)](https://pypi.org/project/mpl-interactions)\n[![Documentation Status](https://readthedocs.org/projects/mpl-interactions/badge/?version=stable)](https://mpl-interactions.readthedocs.io/en/stable/?badge=stable)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ianhi/mpl-interactions/master?urlpath=lab)\n[![Test](https://github.com/ianhi/mpl-interactions/actions/workflows/test.yml/badge.svg)](https://github.com/ianhi/mpl-interactions/actions/workflows/test.yml)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ianhi/mpl-interactions/master.svg)](https://results.pre-commit.ci/latest/github/ianhi/mpl-interactions/master)\n[![Code style: Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://prettier.io)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort)\n\n## Welcome!\n\nmpl_interactions' library provides helpful ways to interact with [Matplotlib](https://matplotlib.org/) plots. Full narrative documentation and example can be found on [Read the Docs](https://mpl-interactions.readthedocs.io).\n\n<img src=https://raw.githubusercontent.com/ianhi/mpl-interactions/master/docs/_static/images/short-interactive.gif width=45%> <img src=https://raw.githubusercontent.com/ianhi/mpl-interactions/master/docs/_static/images/heatmap_slicer.gif width=45%>\n\n## Installation\n\n```bash\npip install mpl_interactions[\"jupyter\"] # will install necessary deps for using in jupyter\n\n# for use only outside of jupyter:\npip install mpl_interactions\n```\n\nIf you use JupyterLab, make sure you follow the full instructions in the ipympl [readme](https://github.com/matplotlib/ipympl#install-the-jupyterlab-extension) in particular installing jupyterlab-manager.\n\n## Contributing / feature requests / roadmap\n\nI use the GitHub [issues](https://github.com/ianhi/mpl-interactions/issues) to keep track of ideas I have, so looking through those should serve as a roadmap of sorts. For the most part I add to the library when I create a function that is useful for the science I am doing. If you create something that seems useful a PR would be most welcome so we can share it easily with more people. I'm also open to feature requests if you have an idea.\n\n## Documentation\n\nThe fuller narrative documentation can be found on [ReadTheDocs](https://mpl-interactions.readthedocs.io/en/latest/). You may also find it helpful to check out the [examples directory](docs/examples).\n\n## Contributors \u2728\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n  <tr>\n    <td align=\"center\"><a href=\"http://ianhi.github.io\"><img src=\"https://avatars0.githubusercontent.com/u/10111092?v=4?s=100\" 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\">\ud83d\udcbb</a></td>\n    <td align=\"center\"><a href=\"https://darlingdocs.wordpress.com/\"><img src=\"https://avatars1.githubusercontent.com/u/67113216?v=4?s=100\" width=\"100px;\" alt=\"\"/><br /><sub><b>Sam</b></sub></a><br /><a href=\"https://github.com/ianhi/mpl-interactions/commits?author=samanthahamilton\" title=\"Documentation\">\ud83d\udcd6</a></td>\n    <td align=\"center\"><a href=\"https://github.com/jcoulter12\"><img src=\"https://avatars1.githubusercontent.com/u/14036348?v=4?s=100\" width=\"100px;\" alt=\"\"/><br /><sub><b>Jenny Coulter</b></sub></a><br /><a href=\"#userTesting-jcoulter12\" title=\"User Testing\">\ud83d\udcd3</a></td>\n    <td align=\"center\"><a href=\"https://sjhaque14.wixsite.com/sjhaque\"><img src=\"https://avatars3.githubusercontent.com/u/61242473?v=4?s=100\" 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\">\ud83d\udcd6</a> <a href=\"#userTesting-sjhaque14\" title=\"User Testing\">\ud83d\udcd3</a> <a href=\"https://github.com/ianhi/mpl-interactions/commits?author=sjhaque14\" title=\"Code\">\ud83d\udcbb</a></td>\n    <td align=\"center\"><a href=\"https://github.com/jrussell25\"><img src=\"https://avatars2.githubusercontent.com/u/35578729?v=4?s=100\" width=\"100px;\" alt=\"\"/><br /><sub><b>John Russell</b></sub></a><br /><a href=\"https://github.com/ianhi/mpl-interactions/commits?author=jrussell25\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#userTesting-jrussell25\" title=\"User Testing\">\ud83d\udcd3</a> <a href=\"https://github.com/ianhi/mpl-interactions/commits?author=jrussell25\" title=\"Documentation\">\ud83d\udcd6</a></td>\n    <td align=\"center\"><a href=\"http://maxshinnpotential.com\"><img src=\"https://avatars2.githubusercontent.com/u/951986?v=4?s=100\" width=\"100px;\" alt=\"\"/><br /><sub><b>Max Shinn</b></sub></a><br /><a href=\"https://github.com/ianhi/mpl-interactions/commits?author=mwshinn\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#userTesting-mwshinn\" title=\"User Testing\">\ud83d\udcd3</a></td>\n    <td align=\"center\"><a href=\"https://github.com/kmdalton\"><img src=\"https://avatars2.githubusercontent.com/u/2790777?v=4?s=100\" width=\"100px;\" alt=\"\"/><br /><sub><b>Kevin Dalton</b></sub></a><br /><a href=\"#userTesting-kmdalton\" title=\"User Testing\">\ud83d\udcd3</a></td>\n  </tr>\n  <tr>\n    <td align=\"center\"><a href=\"https://github.com/redeboer\"><img src=\"https://avatars.githubusercontent.com/u/29308176?v=4?s=100\" width=\"100px;\" alt=\"\"/><br /><sub><b>Remco de Boer</b></sub></a><br /><a href=\"https://github.com/ianhi/mpl-interactions/commits?author=redeboer\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#userTesting-redeboer\" title=\"User Testing\">\ud83d\udcd3</a> <a href=\"https://github.com/ianhi/mpl-interactions/commits?author=redeboer\" title=\"Documentation\">\ud83d\udcd6</a></td>\n    <td align=\"center\"><a href=\"https://github.com/samwelborn\"><img src=\"https://avatars.githubusercontent.com/u/55868530?v=4?s=100\" width=\"100px;\" alt=\"\"/><br /><sub><b>samwelborn</b></sub></a><br /><a href=\"#userTesting-samwelborn\" title=\"User Testing\">\ud83d\udcd3</a></td>\n    <td align=\"center\"><a href=\"http://www.matthewfeickert.com/\"><img src=\"https://avatars.githubusercontent.com/u/5142394?v=4?s=100\" width=\"100px;\" alt=\"\"/><br /><sub><b>Matthew Feickert</b></sub></a><br /><a href=\"https://github.com/ianhi/mpl-interactions/commits?author=matthewfeickert\" title=\"Code\">\ud83d\udcbb</a></td>\n  </tr>\n</table>\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "Matplotlib aware interact functions",
    "version": "0.23.2",
    "project_urls": {
        "Changelog": "https://github.com/mpl-extensions/mpl-interactions/releases",
        "Documentation": "https://mpl-interactions.rtfd.io",
        "Source": "https://github.com/mpl-extensions/mpl-interactions",
        "Tracker": "https://github.com/mpl-extensions/mpl-interactions/issues"
    },
    "split_keywords": [
        "ipython",
        "jupyter",
        "matplotlib",
        "widgets"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "57c1d0b4d7962b7d3336748f95c4da6b54d5ac09fabae40fbe559efe4deff8be",
                "md5": "93c92181972697fdf32653d7af68120b",
                "sha256": "6d1849e49697f091e2d06f493fcbdeaab4924f1ca99855ef6dd95fe0cf5b45bd"
            },
            "downloads": -1,
            "filename": "mpl_interactions-0.23.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "93c92181972697fdf32653d7af68120b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 47302,
            "upload_time": "2023-09-04T20:17:17",
            "upload_time_iso_8601": "2023-09-04T20:17:17.237408Z",
            "url": "https://files.pythonhosted.org/packages/57/c1/d0b4d7962b7d3336748f95c4da6b54d5ac09fabae40fbe559efe4deff8be/mpl_interactions-0.23.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bd50b6a98cd1ae60634b28c1054793a52b6da2b9f00c166ed31a9b3312a0f08f",
                "md5": "4b1635a1975617e6a138b3c8da1b3898",
                "sha256": "97e3f5918a1fc9a4f3f829554f3bb80a8217bc3438cfd3468ace5a055956c4cc"
            },
            "downloads": -1,
            "filename": "mpl_interactions-0.23.2.tar.gz",
            "has_sig": false,
            "md5_digest": "4b1635a1975617e6a138b3c8da1b3898",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 36043802,
            "upload_time": "2023-09-04T20:17:20",
            "upload_time_iso_8601": "2023-09-04T20:17:20.492355Z",
            "url": "https://files.pythonhosted.org/packages/bd/50/b6a98cd1ae60634b28c1054793a52b6da2b9f00c166ed31a9b3312a0f08f/mpl_interactions-0.23.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-04 20:17:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mpl-extensions",
    "github_project": "mpl-interactions",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "mpl-interactions"
}
Ian Hunt-Isaak
Elapsed time: 0.10483s