1-
21# jupyterannotate
32
4- [ ![ Build Status] ( https://travis-ci.org/DataQA/jupyterannotate.svg?branch=master )] ( https://travis-ci.org/DataQA/jupyterannotate )
5- [ ![ codecov] ( https://codecov.io/gh/DataQA/jupyterannotate/branch/master/graph/badge.svg )] ( https://codecov.io/gh/DataQA/jupyterannotate )
6-
3+ ![ Build Status] ( https://github.com/dataqa/jupyter-annotate/actions/workflows/build.yml/badge.svg?branch=main )
74
85A Custom Jupyter Widget Library
96
@@ -17,19 +14,22 @@ pip install jupyterannotate
1714
1815If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable
1916the nbextension:
17+
2018``` bash
2119jupyter nbextension enable --py [--sys-prefix| --user| --system] jupyterannotate
2220```
2321
2422## Development Installation
2523
2624Create a dev environment:
25+
2726``` bash
2827conda create -n jupyterannotate-dev -c conda-forge nodejs yarn python jupyterlab
2928conda activate jupyterannotate-dev
3029```
3130
3231Install the python. This will also build the TS package.
32+
3333``` bash
3434pip install -e " .[test, examples]"
3535```
@@ -55,7 +55,9 @@ you might also need another flag instead of `--sys-prefix`, but we won't cover t
5555of those flags here.
5656
5757### How to see your changes
58+
5859#### Typescript:
60+
5961If you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different
6062terminals to watch for changes in the extension's source and automatically rebuild the widget.
6163
@@ -69,4 +71,5 @@ jupyter lab
6971After a change wait for the build to finish and then refresh your browser and the changes should take effect.
7072
7173#### Python:
74+
7275If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.
0 commit comments