Skip to content

weatherforce/ipyreact

Repository files navigation

ipyreact

Documentation Status Binder

This project aim to provide an alternative solution to build widget and use them on a jupyter notebook. It uses React for the front end, which provides a simple way to build complex widgets.In addition, It will open the way to the integration of React libraries in Jupyter notebooks, such as material-ui, among others.

Alt Text

Installation

This guide assumes that you are using a linux based system.

System requirements

  • npm
  • python3 (it has been tested using python 3.7)
  • pip

Building JavaScript

This builds the react javascript.

npm install -C nbextensions_srcs && npm run dev -C nbextensions_srcs

You should now have a nbextensions_dists folder

Installing Python packages

For installing the python packages an we recommend using a virtual environment

python3 -m venv ipyreactvenv
source ipyreactvenv/bin/activate
pip install -r dev_requirements.txt
pip install .

Running Jupyter notebook

In the same terminal as your virtual environment run:

jupyter notebook examples/slider.ipynb

There are other example ipynb which can be found in the examples folder

About

Ipyreact aim to provide a widget building solution based on React for jupyter notebooks.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published