DANDI Client
The DANDI Python client allows you to:
- Download
Dandisetsand individual subject folders or files - Validate data to locally conform to standards
- Organize your data locally before upload
- Upload
Dandisets - Interact with the DANDI instance's web API from Python
- Delete data in the DANDI instance
- Perform other auxiliary operations with data on the DANDI instance
Note: This project is under active development. See the issues log or Work-in-Progress (WiP).
Installation
DANDI Client releases are available from PyPI and conda-forge. Install them in your Python (native, virtualenv, or conda) environment via
pip install dandi
or
conda install -c conda-forge dandi
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, a DANDI instance such as the DANDI Archive.
$> dandi
Usage: dandi [OPTIONS] COMMAND [ARGS]...
A client to support interactions with DANDI instances, such as the 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 files or entire folders from DANDI.
instances List known DANDI instances that the CLI can interact...
ls List .nwb files and dandisets metadata.
move Move or rename assets in a local Dandiset and/or on...
organize (Re)organize NWB files according to their 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 data standards compliance.
validate-bids Validate BIDS paths.
Run dandi --help or dandi <subcommand> --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 DANDI Docs (specifically the sections on using the CLI to download and upload
Dandisets). -
To get help:
- ask a question: https://github.com/dandi/helpdesk/discussions
- file a feature request or bug report: https://github.com/dandi/helpdesk/issues/new/choose
- contact the DANDI team: help@dandiarchive.org
-
To understand how to contribute to the dandi-cli repository, see the DEVELOPMENT.md file.
Release files for dandi 0.78.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| dandi-0.78.0.tar.gz | 409.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| dandi-0.78.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 818.8 kB
Release files / dandi-0.78.0.tar.gz
| Download URL | dandi-0.78.0.tar.gz |
|---|---|
| Size | 409.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dc6534ce24af32d4654e0d7d526fe1adc9062abd228cf95b7d9ea7defe2e1a0b
|
|
BLAKE2b-256 checksum How to use checksums |
352fa727900c706765df984c2c9016b41f97750f04a64e15e6d5465621b0da9c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.16
|
Release files / dandi-0.78.0-py3-none-any.whl
| Download URL | dandi-0.78.0-py3-none-any.whl |
|---|---|
| Size | 409.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f4cc124e0247964cc2152ddaba473a9701df21a45dd27049e5d7599d1bef9be4
|
|
BLAKE2b-256 checksum How to use checksums |
9149df7708df629f281f8b0ddfce0cfc916080c77a6e7087f50714ce2d42a8db
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.16
|
