From fd60d6ec675b6bacbb0f2ea5764ae180169dba51 Mon Sep 17 00:00:00 2001 From: Mary Elise Dedicke <73657255+melster1010@users.noreply.github.com> Date: Thu, 26 Jan 2023 15:49:57 -0500 Subject: [PATCH 1/2] Fix outstanding readme issues from pr #1170 --- README.md | 95 ++++--------------------------------------------------- 1 file changed, 7 insertions(+), 88 deletions(-) diff --git a/README.md b/README.md index f4649c935..89008181d 100644 --- a/README.md +++ b/README.md @@ -35,98 +35,17 @@ or ## CLI Tool This package provides a command line utility with a basic interface -to help you prepare and upload your data to, or obtain data from, the [DANDI archive](http://dandiarchive.org): - -```bash -$> dandi -Usage: dandi [OPTIONS] COMMAND [ARGS]... - - A client to support interactions with DANDI archive - (http://dandiarchive.org). - - To see help for a specific command, run - - dandi COMMAND --help - - e.g. dandi upload --help - -Options: - --version - -l, --log-level [DEBUG|INFO|WARNING|ERROR|CRITICAL] - Log level (case insensitive). May be - specified as an integer. [default: INFO] - --pdb Fall into pdb if errors out - --help Show this message and exit. - -Commands: - delete Delete dandisets and assets from the server. - digest Calculate file digests - download Download a file or entire folder from DANDI. - instances List known Dandi Archive instances that the CLI can... - ls List .nwb files and dandisets metadata. - move Move or rename assets in a local Dandiset and/or on... - organize (Re)organize files according to the metadata. - service-scripts Various utility operations - shell-completion Emit shell script for enabling command completion. - upload Upload Dandiset files to DANDI Archive. - validate Validate files for NWB and DANDI compliance. - validate-bids Validate BIDS paths. -``` - -Each of the commands has a set of options to alter its behavior. Run -`dandi COMMAND --help` to get more information: - -``` -$> dandi ls --help -Usage: dandi ls [OPTIONS] PATH|URL - - List .nwb files and dandisets metadata. - - The arguments may be either resource identifiers or paths to local - files/directories. - - Accepted resource identifier patterns: - - DANDI:[/] - - https://dandiarchive.org/... - - https://identifiers.org/DANDI:[/] ( cannot be 'draft') - - https://[/api]/[#/]dandiset/[/][/files[?location=]] - - https://*dandiarchive-org.netflify.app/... - - https://[/api]/dandisets/[/versions[/]] - - https://[/api]/assets/[/download] - - https://[/api]/dandisets//versions//assets/[/download] - - https://[/api]/dandisets//versions//assets/?path= - - dandi:///[@][/] - - https:///... - -Options: - -F, --fields TEXT Comma-separated list of fields to display. - An empty value to trigger a list of - available fields to be printed out - -f, --format [auto|pyout|json|json_pp|json_lines|yaml] - Choose the format/frontend for output. If - 'auto', 'pyout' will be used in case of - multiple files, and 'yaml' for a single - file. - -r, --recursive Recurse into content of - dandisets/directories. Only .nwb files will - be considered. - -J, --jobs INTEGER Number of parallel download jobs. [default: - 6] - --metadata [api|all|assets] - --schema VERSION Convert metadata to new schema version - --help Show this message and exit. -``` - - -## Third-party Components - -**dandi/tests/skip.py** -- from https://github.com/ReproNim/reproman, as of v0.2.1-40-gf4f026d -Copyright (c) 2016-2020 ReproMan Team +to help you prepare and upload your data to, or obtain data from, the [DANDI archive](http://dandiarchive.org). + +Run `dandi --help` or `dandi --help` (e.g. `dandi upload --help`) to see manual pages. ## Resources * To learn how to interact with the DANDI archive and for examples on how to use the DANDI Client in various use cases, -see [the handbook](https://www.dandiarchive.org/handbook/). +see [the handbook](https://www.dandiarchive.org/handbook/) + (specifically the sections on using the CLI to +[download](https://www.dandiarchive.org/handbook/12_download/) and +[upload](https://www.dandiarchive.org/handbook/13_upload/) `Dandisets`). * To get help: - ask a question: https://github.com/dandi/helpdesk/discussions From b71f647d301072a6f06e1e2087415802b72a0903 Mon Sep 17 00:00:00 2001 From: Mary Elise Dedicke <73657255+melster1010@users.noreply.github.com> Date: Fri, 27 Jan 2023 12:58:39 -0500 Subject: [PATCH 2/2] Restore interface UI graphic --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index 89008181d..7317ca81d 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,42 @@ or This package provides a command line utility with a basic interface to help you prepare and upload your data to, or obtain data from, the [DANDI archive](http://dandiarchive.org). + +```bash +$> dandi +Usage: dandi [OPTIONS] COMMAND [ARGS]... + + A client to support interactions with DANDI archive + (http://dandiarchive.org). + + To see help for a specific command, run + + dandi COMMAND --help + + e.g. dandi upload --help + +Options: + --version + -l, --log-level [DEBUG|INFO|WARNING|ERROR|CRITICAL] + Log level (case insensitive). May be + specified as an integer. [default: INFO] + --pdb Fall into pdb if errors out + --help Show this message and exit. + +Commands: + delete Delete dandisets and assets from the server. + digest Calculate file digests + download Download a file or entire folder from DANDI. + instances List known Dandi Archive instances that the CLI can... + ls List .nwb files and dandisets metadata. + move Move or rename assets in a local Dandiset and/or on... + organize (Re)organize files according to the metadata. + service-scripts Various utility operations + shell-completion Emit shell script for enabling command completion. + upload Upload Dandiset files to DANDI Archive. + validate Validate files for NWB and DANDI compliance. + validate-bids Validate BIDS paths. +``` Run `dandi --help` or `dandi --help` (e.g. `dandi upload --help`) to see manual pages. ## Resources