Export interactive HTML pages from Jupyter Notebooks
Project description
nbinteract
=================
[][docs]
[](https://pypi.python.org/pypi/nbinteract/)
[](https://www.npmjs.com/package/nbinteract)
`nbinteract` is a set of tools to create interactive webpages using Jupyter
notebooks. Before, creating an interactive webpage required authors to know
HTML, CSS, and Javascript. With `nbinteract`, if you know Python you know how
to create an interactive webpage. `nbinteract` makes explanations that make use
of data especially easy because of its support for interactive visualizations.
Currently, `nbinteract` is in an alpha stage because of its quickly-changing
API.
## Demo
[Click this link to view live.][demo]
## Use Cases
`nbinteract` can be used by:
- Data scientists that want to create an interactive blog post without having
to know / work with Javascript.
- Instructors that want to include interactive examples in their textbooks.
- Students that want to publish data analysis that contains interactive demos.
## Tutorial and Documentation
[Here's a link to the tutorial and docs for this project.][docs]
## Getting Started
To install the package, you must first have
[Jupyter Notebook installed][install-nb]. Then, run:
```
pip install nbinteract
```
Navigate to a folder containing notebooks you'd like to convert, then run:
```
nbinteract YOUR_NOTEBOOK.ipynb
```
Replace `YOUR_NOTEBOOK.ipynb` with the name of your notebook file. You will now
have an HTML file in the same directory. You can open that HTML file in your
browser and interact with widgets there.
## Developer Install
If you are interested in developing this project locally, run the following:
```
git clone https://github.com/SamLau95/nbinteract
cd nbinteract
# Installs the nbconvert exporter
pip install -e .
# To export a notebook to interactive HTML format:
jupyter nbconvert --to interact notebooks/Test.ipynb
pip install -U ipywidgets
jupyter nbextension enable --py --sys-prefix widgetsnbextension
brew install yarn
yarn install
# Start notebook and webpack servers
make -j2 serve
```
## Contributors
This project is developed by [Sam Lau][sam] and Caleb Siu as part of a Masters
project at UC Berkeley.
[demo]: https://samlau95.gitbooks.io/nbinteract/content/examples/Correlation.html
[ipywidgets]: https://github.com/jupyter-widgets/ipywidgets
[bqplot]: https://github.com/bloomberg/bqplot
[widgets]: http://jupyter.org/widgets.html
[gh-pages]: https://pages.github.com/
[gitbook]: http://gitbook.com/
[install-nb]: http://jupyter.readthedocs.io/en/latest/install.html
[docs]: https://samlau95.gitbooks.io/nbinteract/content/
[sam]: http://www.samlau.me/
=================
[][docs]
[](https://pypi.python.org/pypi/nbinteract/)
[](https://www.npmjs.com/package/nbinteract)
`nbinteract` is a set of tools to create interactive webpages using Jupyter
notebooks. Before, creating an interactive webpage required authors to know
HTML, CSS, and Javascript. With `nbinteract`, if you know Python you know how
to create an interactive webpage. `nbinteract` makes explanations that make use
of data especially easy because of its support for interactive visualizations.
Currently, `nbinteract` is in an alpha stage because of its quickly-changing
API.
## Demo
[Click this link to view live.][demo]
## Use Cases
`nbinteract` can be used by:
- Data scientists that want to create an interactive blog post without having
to know / work with Javascript.
- Instructors that want to include interactive examples in their textbooks.
- Students that want to publish data analysis that contains interactive demos.
## Tutorial and Documentation
[Here's a link to the tutorial and docs for this project.][docs]
## Getting Started
To install the package, you must first have
[Jupyter Notebook installed][install-nb]. Then, run:
```
pip install nbinteract
```
Navigate to a folder containing notebooks you'd like to convert, then run:
```
nbinteract YOUR_NOTEBOOK.ipynb
```
Replace `YOUR_NOTEBOOK.ipynb` with the name of your notebook file. You will now
have an HTML file in the same directory. You can open that HTML file in your
browser and interact with widgets there.
## Developer Install
If you are interested in developing this project locally, run the following:
```
git clone https://github.com/SamLau95/nbinteract
cd nbinteract
# Installs the nbconvert exporter
pip install -e .
# To export a notebook to interactive HTML format:
jupyter nbconvert --to interact notebooks/Test.ipynb
pip install -U ipywidgets
jupyter nbextension enable --py --sys-prefix widgetsnbextension
brew install yarn
yarn install
# Start notebook and webpack servers
make -j2 serve
```
## Contributors
This project is developed by [Sam Lau][sam] and Caleb Siu as part of a Masters
project at UC Berkeley.
[demo]: https://samlau95.gitbooks.io/nbinteract/content/examples/Correlation.html
[ipywidgets]: https://github.com/jupyter-widgets/ipywidgets
[bqplot]: https://github.com/bloomberg/bqplot
[widgets]: http://jupyter.org/widgets.html
[gh-pages]: https://pages.github.com/
[gitbook]: http://gitbook.com/
[install-nb]: http://jupyter.readthedocs.io/en/latest/install.html
[docs]: https://samlau95.gitbooks.io/nbinteract/content/
[sam]: http://www.samlau.me/
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for nbinteract-0.0.22-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8140eb6532ed2b2da74b1c3186e7dbad9f7fbd86df1090378ca7ded9c4b781e3 |
|
| MD5 | 477db5b9894a6832faad2b47e27eeb73 |
|
| BLAKE2b-256 | fc375c9dc4c578d0cf96baf50a7094ad09e5a1d3d1f618c7bc8d8ca4006887f1 |
