diff --git a/dandi/consts.py b/dandi/consts.py index 4ab98e514..e10d07fec 100644 --- a/dandi/consts.py +++ b/dandi/consts.py @@ -1,3 +1,12 @@ +"""Constants and configuration for DANDI CLI. + +This module defines constants used throughout the DANDI CLI including: +- Metadata field definitions for NWB files +- Known DANDI Archive instances and their configurations +- File organization patterns and BIDS-related constants +- Request timeouts and retry settings +""" + from __future__ import annotations from collections.abc import Iterator diff --git a/dandi/dandiapi.py b/dandi/dandiapi.py index f133d32dd..de5947d09 100644 --- a/dandi/dandiapi.py +++ b/dandi/dandiapi.py @@ -1,3 +1,15 @@ +"""REST API client for interacting with DANDI Archive instances. + +This module provides client classes for communicating with DANDI Archive API +servers, including asset management, dandiset operations, and authentication. + +The main classes are: +- DandiAPIClient: High-level client for DANDI API operations +- RESTFullAPIClient: Base HTTP client with retry and authentication +- RemoteDandiset: Represents a dandiset on the server +- RemoteAsset: Represents an asset (file) on the server +""" + from __future__ import annotations from abc import ABC, abstractmethod diff --git a/dandi/exceptions.py b/dandi/exceptions.py index 01cd63c69..fc8639dff 100644 --- a/dandi/exceptions.py +++ b/dandi/exceptions.py @@ -1,3 +1,10 @@ +"""Custom exceptions for DANDI CLI operations. + +This module defines exception classes used throughout the DANDI CLI for +handling various error conditions including network errors, validation +failures, and version incompatibilities. +""" + from __future__ import annotations import requests