diff --git a/todos/Jupyter-OpenBIS-extension todos.md b/todos/Jupyter-OpenBIS-extension todos.md new file mode 100644 index 0000000000000000000000000000000000000000..7b51fc65b31337372178efbd013399a1251b6b70 --- /dev/null +++ b/todos/Jupyter-OpenBIS-extension todos.md @@ -0,0 +1,52 @@ +# Jupyter-OpenBIS-extension todos + + +## 1) separate database connection from download/upload dialogue. + - Make it a 3rd button + - allow only one openBIS-instance (data source) per notebook + - after the choice has been made, store the choice in the notebooks' metadata + - do not allow to change the data source after that (upload & download) + - the reason behind this measure: we need to make sure that we can create a graph + of all parent datasets. This is only possible if those datasets origin from the same source. + - in future, we might think in terms of workflows that allow data origin from multiple sources. + + +## 2) Download datasets + - allow search for experiments by sample code only + - paging when a lot of datasets are displayed (>50) + + +## 3) Uploading datasets + - let the upload dialog box stay in place until the upload was successful + - if metadata is faulty, tell the user to correct them (e.g. invalid vocabulary) + - show which metadata is mandatory and which are optional + - if dataset type is changed back and forth, keep the values that already have been entered + - keep choice of current dataset type + + - show list of downloaded datasets + - They should all be parents of the new dataset by default. + - User should be able to de-select certain parent datasets + + - show list of files in the current working directory + - this list should be served from the jupyter-server-extension, + since the user might not be working on his own machine + - allow to select one ore many files to upload together with the notebook + + +## 4) Packaging + - pip install --upgrade jupyter-openbis-extension # install the jupyter-server-extension + - jupyter serverextension enable --py jupyter-openbis-extension # enable the extension + - jupyter nbextension install --py jupyter-openbis-extension --user # install the nbextension (JS) + - jupyter nbextension enable jupyter-openbis-extension --user --py # activate the nbextension (JS) + - try and debug it on a clean machine + +## 5) Testing + - pytest for jupyter-notebook-extension + - test app in different browsers on different platforms (including Windows!) + + +## 6) Details/nice to have: + - change upload (or download) icon: from cloud, to cloud + - progression bar or sth to show that it is downloading and doing somehting + - more sophisticated forms when uploading datasets + - remove remaining jQuery parts to make it easily portable to future Jupyter Lab \ No newline at end of file diff --git a/todos/screenshots/download_datasets.png b/todos/screenshots/download_datasets.png new file mode 100644 index 0000000000000000000000000000000000000000..03a825839945b7af9277b8723f9bedd2504db3a8 Binary files /dev/null and b/todos/screenshots/download_datasets.png differ diff --git a/todos/screenshots/feedback_after_download.png b/todos/screenshots/feedback_after_download.png new file mode 100644 index 0000000000000000000000000000000000000000..04b30f5f6c6968c71b1da669dee4548af119c9a9 Binary files /dev/null and b/todos/screenshots/feedback_after_download.png differ diff --git a/todos/screenshots/openbis_buttons.png b/todos/screenshots/openbis_buttons.png new file mode 100644 index 0000000000000000000000000000000000000000..c74dcbde7a2b80e56d01f96ff0f30c1741b99e47 Binary files /dev/null and b/todos/screenshots/openbis_buttons.png differ diff --git a/todos/screenshots/upload_datasets.png b/todos/screenshots/upload_datasets.png new file mode 100644 index 0000000000000000000000000000000000000000..3e4cf33490f789c78fb880f090eb660e9737de09 Binary files /dev/null and b/todos/screenshots/upload_datasets.png differ