Command line client for interaction with DANDI archive elements
Project description
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 archive's web API from Python
- Delete data in the DANDI archive
- Perform other auxiliary operations with data or the DANDI archive
Note: This project is under heavy 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, the DANDI archive.
$> 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 NWB files according to their metadata.
shell-completion Emit shell script for enabling command completion.
upload Upload Dandiset files to DANDI Archive.
validate Validate files for data standards compliance.
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 handbook (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 history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file dandi-0.64.0.tar.gz.
File metadata
- Download URL: dandi-0.64.0.tar.gz
- Upload date:
- Size: 314.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a44ea8863f865cfe85afce18c2299cd1c324c6ac56efafccd84e7a920967e731 |
|
| MD5 | 8c444a0db06b26aa0508c96f955369f0 |
|
| BLAKE2b-256 | 66bc0e6660590d847165c4f5e8e336ba6b4e12ed65b77c15fc72cdbaab60a076 |
File details
Details for the file dandi-0.64.0-py3-none-any.whl.
File metadata
- Download URL: dandi-0.64.0-py3-none-any.whl
- Upload date:
- Size: 309.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cc92de6d95fe06ac8c0393b2bbb822a71f90914d68c268596ce858be8ad57568 |
|
| MD5 | 886ed21de6a0231846b979b72d7ff42e |
|
| BLAKE2b-256 | 35fec84faa72ca0b5939fd73e1921649c18df06db06ecfdcb1434662739b50e7 |
