dotdata_widgets v1.0.0
Dotdata Widgets
Dotdata widgets consist of a NodeJS library and a python module.
Building the nodejs
part
In order to build the nodejs part of dotdata widgets - follow the make
targets
defined in the Makefile
in this directory.
make build_js
There is an alias for this command in the root-level Makefile
:
make -C ../../ build_widgets_js_for_iff
NOTE: this command might not work if on platforms other than linux.
The docker container in which the commands are executed is based on node:18.15
container,
which assumes that the working user has UID=1000
.
Calling it on MacOS may produce artifacts with invalid ownership.
In order to build the nodejs package without the docker, make sure you've provisioned your local environment
as described in the docker/npm/Dockerfile
. Especially make sure that you have:
- node in version >=18
- yarn (
npm install yarn -g
) - python >=3.8
- jupyterlab
Then you may call:
make -C ../../ build_js_without_docker
Publishing the js part of Dotdata Widgets
DO NOT publish the nodejs package unless you're sure what you're doing!
Dotdata Widgets are published in a public npm repository. You can browse the published packages at https://www.npmjs.com/package/dotdata_widgets
Dotdata widgets are published together with the dotdata wheel by the jenkins job,
which calls make publish_iff
from the root-level Makefile
.
This command refers to the npm publish
command, which utilises credentials to npm registry
defined in .npmrc
Interactive development and testing
WARNING: THERE ARE NO AUTOMATED TESTS OF DOTDATA WIDGETS (neither JS nor python part).
Dotdata widgets can be tested manually in a jupyter notebook.
In order to do so do the following:
- Prune local virtual env:
This command cleans the venv directory and deletes pre-existing artifacts.make -C ../../ prune_iff_test_env
- Install
dotdata
in dev mode in the local virtual env:
This command installsmake -C ../../ prepare_iff_interactive_dev_env
jupyterlab
, installsdotdata
in--editable
mode, and callsjupyter labextension develop --overwrite ${PATH_TO_DOTDAT_WIDGETS}
. Although it make take up to 20 minutes, it has to be called only once. - Launch widgets compilation server:
make -C ../../ _run_yarn_watch_compilation_of_dotdata_widgets
- NOTE: this command requires
node
andyarn
to be installed in your environment. - Also, it fails if
prepare_iff_interactive_dev_env
wasn't called before. - This command spawns a server that watches for changes in the ts files and recompiles them on the fly.
- Run it in separate terminal.
- A single recompilation may take up to a minute, so be patient.
- NOTE: this command requires
- Launch jupyter lab:
make -C ../../ _start_jupyterlab
- This command spawns a jupyter-lab server. Run it in separate terminal.
- It also opens a browser window with a jupyter lab workspace.
- Open a notebook (e.g.
examples/introduction.ipynb
) and work with your widgets.
When developing widgets in interactive mode, keep in mind that:
- you have to reload browser caches in order to force it to load re-compiled
*.js
files. - you have to restart notebook's kernel in order to load modified python modules.
6 days ago
7 days ago
6 days ago
8 days ago
10 days ago
10 days ago
11 days ago
11 days ago
12 days ago
13 days ago
12 days ago
13 days ago
12 days ago
14 days ago
13 days ago
15 days ago
16 days ago
18 days ago
18 days ago
18 days ago
19 days ago
19 days ago
20 days ago
21 days ago
22 days ago
24 days ago
25 days ago
26 days ago
27 days ago
28 days ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
9 months ago
7 months ago
6 months ago
9 months ago
10 months ago
6 months ago
8 months ago
10 months ago
8 months ago
7 months ago
10 months ago
5 months ago
10 months ago
8 months ago
6 months ago
6 months ago
6 months ago
7 months ago
8 months ago
5 months ago
8 months ago
9 months ago
6 months ago
8 months ago
6 months ago
5 months ago
5 months ago
7 months ago
8 months ago
9 months ago
5 months ago
9 months ago
5 months ago
5 months ago
6 months ago
7 months ago
6 months ago
7 months ago
8 months ago
8 months ago
8 months ago
5 months ago
9 months ago
9 months ago
8 months ago
6 months ago
7 months ago
8 months ago
5 months ago
8 months ago
7 months ago
9 months ago
8 months ago
6 months ago
7 months ago
8 months ago
9 months ago
7 months ago
6 months ago
8 months ago
6 months ago
6 months ago
9 months ago
8 months ago
5 months ago
10 months ago
6 months ago
7 months ago
8 months ago
6 months ago
9 months ago
7 months ago
5 months ago
6 months ago
8 months ago
6 months ago
9 months ago
7 months ago
6 months ago
5 months ago
6 months ago
10 months ago
7 months ago
7 months ago
6 months ago
10 months ago
6 months ago
7 months ago
9 months ago
6 months ago
9 months ago
10 months ago
10 months ago
6 months ago
7 months ago
8 months ago
7 months ago
10 months ago
8 months ago
6 months ago
9 months ago
9 months ago
8 months ago
6 months ago
10 months ago
6 months ago
8 months ago
5 months ago
9 months ago
5 months ago
6 months ago
6 months ago
10 months ago
6 months ago
7 months ago
7 months ago
9 months ago
10 months ago
10 months ago
10 months ago
7 months ago
7 months ago
9 months ago
9 months ago
8 months ago
6 months ago
5 months ago
8 months ago
9 months ago
8 months ago
10 months ago
6 months ago
7 months ago
7 months ago
6 months ago
9 months ago
7 months ago
9 months ago
7 months ago
6 months ago
6 months ago
9 months ago
7 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
11 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
12 months ago
12 months ago
11 months ago
12 months ago
12 months ago
12 months ago
11 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
11 months ago
11 months ago
11 months ago
11 months ago
12 months ago
12 months ago
11 months ago
12 months ago
11 months ago
11 months ago
12 months ago
12 months ago
12 months ago
11 months ago
12 months ago
11 months ago
12 months ago
12 months ago
1 year ago
1 year ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
12 months ago
1 year ago
1 year ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
12 months ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago