Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update links in the Readme #3165
Update links in the Readme #3165
Changes from all commits
5a30efc
becaad0
9b15c1a
25bf49e
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
ipywidgets: Interactive HTML Widgets
ipywidgets, also known as jupyter-widgets or simply widgets, are interactive HTML widgets for Jupyter notebooks and the IPython kernel.
Notebooks come alive when interactive widgets are used. Users gain control of their data and can visualize changes in the data.
Learning becomes an immersive, fun experience. Researchers can easily see how changing inputs to a model impact the results. We hope you will add ipywidgets to your notebooks, and we're here to help you get started.
Core Interactive Widgets
The fundamental widgets provided by this library are called core interactive widgets. A demonstration notebook provides an overview of the core interactive widgets, including:
Jupyter Interactive Widgets as a Framework
Besides the widgets already provided with the library, the framework can be extended with the development of custom widget libraries. For detailed information, please refer to the ipywidgets documentation.
Cookiecutter template for custom widget development
A template project for building custom widgets is available as a cookiecutter. This cookiecutter project helps custom widget authors get started with the packaging and the distribution of their custom Jupyter interactive widgets. The cookiecutter produces a project for a Jupyter interactive widget library following the current best practices for using interactive widgets. An implementation for a placeholder "Hello World" widget is provided as an example.
Popular widget libraries such as bqplot, pythreejs and ipyleaflet follow exactly the same template and directory structure. They serve as more advanced examples of usage of the Jupyter widget infrastructure.
Popular custom widget examples
Examples of custom widget libraries built upon ipywidgets are
Install
The stable version of ipywidgets can be installed with pip or conda. If using JupyterLab, review the Front-end extension for JupyterLab section.
With pip:
With conda:
Developer install from source
Installing from source is more complicated and requires a developer install, see the detailed developer install instructions.
If you want to install ipywidgets from source, you will need the yarn package manager version 1.2.1 or later. To install the latest master version from the root directory of the source code, run
dev-install.sh
. To only build the Python package enterpip install -e .
.Usage
See the examples section of the documentation. The widgets are being used in a variety of ways; some uses can be seen in these notebooks: Demo notebook of interactive widgets
Change log
Change log
Version Compatibility with Front-End Clients
Refer to change log for more detail.
Contributing to ipywidgets
Developer information
License
We use a shared copyright model that enables all contributors to maintain the copyright on their contributions.
See the LICENSE file in this repository for details.
Project Jupyter resources