Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "Download/Connect via Python Client" Modal to Dataset View #6148

Closed
jstriebel opened this issue Apr 14, 2022 · 0 comments · Fixed by #6283
Closed

Add "Download/Connect via Python Client" Modal to Dataset View #6148

jstriebel opened this issue Apr 14, 2022 · 0 comments · Fixed by #6283

Comments

@jstriebel
Copy link
Contributor

Detailed Description

To make the Python client and functionality more discoverable, it would be great to have the download code next to the normal download functionality in the dataset view (see #5672). The specific code to download the current dataset (or a subpart) could be shown as a text-block with a copy-button next to it. The content could be something like:

pip install webknossos
import webknossos as wk

with wk.webknossos_context(token="MY_TOKEN"):
    dataset = wk.Dataset.download(
        dataset_name_or_url="dataset_name",
        organization_id="my_organization",
    )

With links to the generic documentation and the exact download methods:
https://docs.webknossos.org/api/webknossos/dataset/dataset.html#Dataset.download
https://docs.webknossos.org/webknossos-py

We might want to adapt the code, depending on if it's a public dataset (no token necessary) or if it uses a sharing token. We might also add UI to specify a subset (bbox, layers, mags).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants