Skip to content
Snippets Groups Projects
Commit 9555196b authored by Swen Vermeul's avatar Swen Vermeul
Browse files

added todo list

parent d44a8755
No related branches found
No related tags found
No related merge requests found
# 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
todos/screenshots/download_datasets.png

257 KiB

todos/screenshots/feedback_after_download.png

145 KiB

todos/screenshots/openbis_buttons.png

48.1 KiB

todos/screenshots/upload_datasets.png

206 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment