Be sure to have a working installation of Node.js >= 14.
Create and activate a virtual environment using conda or pyenv:
# Using pyenv
pyenv virtualenv 3.6.10 ipysigma
pyenv local ipysigma
# Using conda
conda create -n ipysigma-dev -c conda-forge nodejs yarn python jupyterlab
conda activate ipysigma-devThen run the deps task of the Makefile to install and build everything necessary:
make deps
If you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the widget.
# Watch the source directory in one terminal, automatically rebuilding when needed
make watch
# Run JupyterLab in another terminal
jupyter labAfter a change wait for the build to finish and then refresh your browser and the changes should take effect.
If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.
To update the readme, make your changes in README.template.md then run the following command:
make readme
You need to make sure to update the version in the following files:
package.jsonipysigma/_frontend.pyipysigma/_version.py
Run make release.