Export interactive HTML pages from Jupyter Notebooks
Project description
nbinteract
=================
[][docs]
[](https://pypi-hypernode.com/pypi/nbinteract/0.0.10)
[](https://www.npmjs.com/package/nbinteract)
nbinteract is a tool to convert Jupyter Notebooks to interactive webpages. It
allows notebooks that use [ipywidgets][] or [bqplot][] to be hosted online as
HTML pages for anyone to view and interact with.
Before, creating an interactive webpage required authors to know HTML, CSS, and
Javascript. With `nbinteract`, authors just need to know Python.
## 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.
## 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.
## Documentation
[Here's a link to the documentation for this project.][docs]
## 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
```
[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/
=================
[][docs]
[](https://pypi-hypernode.com/pypi/nbinteract/0.0.10)
[](https://www.npmjs.com/package/nbinteract)
nbinteract is a tool to convert Jupyter Notebooks to interactive webpages. It
allows notebooks that use [ipywidgets][] or [bqplot][] to be hosted online as
HTML pages for anyone to view and interact with.
Before, creating an interactive webpage required authors to know HTML, CSS, and
Javascript. With `nbinteract`, authors just need to know Python.
## 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.
## 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.
## Documentation
[Here's a link to the documentation for this project.][docs]
## 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
```
[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/
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
File details
Details for the file nbinteract-0.0.12-py3-none-any.whl.
File metadata
- Download URL: nbinteract-0.0.12-py3-none-any.whl
- Upload date:
- Size: 9.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 20197b3e82c368c0ad040dab722c9a3e215a161bcaae95f88f64a0ce1a719d8d |
|
| MD5 | 19f645ae334c9cb8e8f24f8ae9901273 |
|
| BLAKE2b-256 | b142d4f3b59cd3a678e5b0e810cb91e8c70edc5f1299d55e99a0dd12f8b78efd |
