Skip to main content

Command line client for interaction with DANDI archive elements

Project description

DANDI Client

Tests GitHub release PyPI version Documentation Status

This project is under heavy development. Beware of hidden and disclosed issues, or Work-in-Progress (WiP).


At the moment DANDI client releases are available from PyPI and conda-forge. You could install them in your Python (native, virtualenv, or conda) environment via

pip install dandi


conda install -c conda-forge dandi

if you are in a conda environment.

dandi tool

This package provides a dandi command line utility with a basic interface which should assist you in preparing and uploading your data to and/or obtaining data from the

$> dandi
Usage: dandi [OPTIONS] COMMAND [ARGS]...

  A client to support interactions with DANDI archive

  To see help for a specific command, run

      dandi COMMAND --help

  e.g. dandi upload --help

                                  Log level name  [default: INFO]
  --pdb                           Fall into pdb if errors out
  --help                          Show this message and exit.

  download  Download a file or entire folder from DANDI
  ls        List .nwb files and dandisets metadata.
  organize  (Re)organize files according to the metadata.
  register  Register a new dandiset in the DANDI archive
  upload    Upload dandiset (files) to DANDI archive.
  validate  Validate files for NWB (and DANDI) compliance.

Each of the commands has a set of options to alter their behavior. Please run dandi COMMAND --help to get more information, e.g.

$> dandi ls --help
Usage: dandi ls [OPTIONS] [PATHS]...

  List .nwb files metadata

  -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|yaml]
                                  Choose the format/frontend for output. If
                                  'auto', 'pyout' will be used in case of
                                  multiple files, and 'yaml' for a single
  --help                          Show this message and exit.

See DANDI Handbook for examples on how to use this client in various use cases.


Please see file.

3rd party components included


From, as of v0.2.1-40-gf4f026d Copyright (c) 2016-2020 ReproMan Team

Project details

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

dandi-0.46.6.tar.gz (218.9 kB view hashes)

Uploaded source

Built Distribution

dandi-0.46.6-py3-none-any.whl (216.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page