Skip to main content

Command line client for interaction with DANDI instances

Project description

DANDI Client

Tests codecov.io Conda Gentoo (::science) GitHub release PyPI version fury.io Documentation Status

The DANDI Python client allows you to:

  • Download Dandisets and 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 a DANDI instance, 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 a file or entire folder 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.
  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

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.69.3.tar.gz (347.6 kB view details)

Uploaded Source

Built Distribution

dandi-0.69.3-py3-none-any.whl (354.1 kB view details)

Uploaded Python 3

File details

Details for the file dandi-0.69.3.tar.gz.

File metadata

  • Download URL: dandi-0.69.3.tar.gz
  • Upload date:
  • Size: 347.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for dandi-0.69.3.tar.gz
Algorithm Hash digest
SHA256 87c15e5897fdf826b9b8404145d8c48a82493064c266b70f8433f6a6602876a8
MD5 96bb2c5145436611eec42c14c87b9bff
BLAKE2b-256 2f8aafecb99975b3bb413f4a1147149a2627ae190eb840eae6f957e79e72779f

See more details on using hashes here.

File details

Details for the file dandi-0.69.3-py3-none-any.whl.

File metadata

  • Download URL: dandi-0.69.3-py3-none-any.whl
  • Upload date:
  • Size: 354.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for dandi-0.69.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f783363a625d67f87fdc0b96c38f4821c576c65a4a427b9dc282cb53b958ee54
MD5 9e94d6fcd886b9e90b7cb4ef6c2696a1
BLAKE2b-256 5dc8202fbe79134fa94738203521985f0ee727268d0e0874cf673b08f189c2b2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page