Python API

High-level user interfaces

Such interfaces mirror Command-Line Interfaces.

delete
download
move
organize	ATM primarily a sandbox for some functionality for dandi organize
upload
validate

Mid-level user interfaces

These interfaces provide object-oriented interfaces to manipulate Dandisets and assets in the archive.

• dandi.dandiarchive
  • ParsedDandiURL
    • ParsedDandiURL.instance
    • ParsedDandiURL.dandiset_id
    • ParsedDandiURL.version_id
    • ParsedDandiURL.api_url
    • ParsedDandiURL.get_client()
    • ParsedDandiURL.get_dandiset()
    • ParsedDandiURL.get_assets()
    • ParsedDandiURL.get_asset_ids()
    • ParsedDandiURL.navigate()
  • DandisetURL
    • DandisetURL.get_assets()
    • DandisetURL.instance
    • DandisetURL.dandiset_id
    • DandisetURL.version_id
  • SingleAssetURL
    • SingleAssetURL.instance
    • SingleAssetURL.dandiset_id
    • SingleAssetURL.version_id
  • MultiAssetURL
    • MultiAssetURL.path
  • BaseAssetIDURL
    • BaseAssetIDURL.dandiset_id
    • BaseAssetIDURL.version_id
    • BaseAssetIDURL.asset_id
    • BaseAssetIDURL.get_assets()
    • BaseAssetIDURL.get_asset_ids()
    • BaseAssetIDURL.navigate()
  • AssetIDURL
    • AssetIDURL.asset_id
    • AssetIDURL.get_assets()
    • AssetIDURL.get_asset_ids()
  • AssetPathPrefixURL
    • AssetPathPrefixURL.get_assets()
    • AssetPathPrefixURL.path
    • AssetPathPrefixURL.instance
    • AssetPathPrefixURL.dandiset_id
    • AssetPathPrefixURL.version_id
  • AssetItemURL
    • AssetItemURL.path
    • AssetItemURL.get_assets()
  • AssetFolderURL
    • AssetFolderURL.get_assets()
    • AssetFolderURL.path
    • AssetFolderURL.instance
    • AssetFolderURL.dandiset_id
    • AssetFolderURL.version_id
  • AssetGlobURL
    • AssetGlobURL.get_assets()
    • AssetGlobURL.path
    • AssetGlobURL.instance
    • AssetGlobURL.dandiset_id
    • AssetGlobURL.version_id
  • navigate_url()
  • parse_dandi_url()
  • follow_redirect()

Low-level user interfaces

Low level interfaces to e.g. interact with archive REST API interfaces and files directly.

• dandi.dandiapi
  • Client
    • RESTFullAPIClient
      • RESTFullAPIClient.delete()
      • RESTFullAPIClient.get()
      • RESTFullAPIClient.get_url()
      • RESTFullAPIClient.page_size
      • RESTFullAPIClient.page_workers
      • RESTFullAPIClient.paginate()
      • RESTFullAPIClient.patch()
      • RESTFullAPIClient.post()
      • RESTFullAPIClient.put()
      • RESTFullAPIClient.request()
    • DandiAPIClient
      • DandiAPIClient.authenticate()
      • DandiAPIClient.check_schema_version()
      • DandiAPIClient.create_dandiset()
      • DandiAPIClient.dandi_authenticate()
      • DandiAPIClient.for_dandi_instance()
      • DandiAPIClient.get_asset()
      • DandiAPIClient.get_dandiset()
      • DandiAPIClient.get_dandisets()
      • DandiAPIClient.page_size
      • DandiAPIClient.page_workers
  • Dandisets
    • RemoteDandiset
      • RemoteDandiset.api_path
      • RemoteDandiset.api_url
      • RemoteDandiset.client
      • RemoteDandiset.contact_person
      • RemoteDandiset.created
      • RemoteDandiset.delete()
      • RemoteDandiset.download_directory()
      • RemoteDandiset.draft_version
      • RemoteDandiset.embargo_status
      • RemoteDandiset.for_version()
      • RemoteDandiset.from_data()
      • RemoteDandiset.get_asset()
      • RemoteDandiset.get_asset_by_path()
      • RemoteDandiset.get_assets()
      • RemoteDandiset.get_assets_by_glob()
      • RemoteDandiset.get_assets_with_path_prefix()
      • RemoteDandiset.get_metadata()
      • RemoteDandiset.get_raw_metadata()
      • RemoteDandiset.get_version()
      • RemoteDandiset.get_versions()
      • RemoteDandiset.identifier
      • RemoteDandiset.iter_upload_raw_asset()
      • RemoteDandiset.json_dict()
      • RemoteDandiset.modified
      • RemoteDandiset.most_recent_published_version
      • RemoteDandiset.publish()
      • RemoteDandiset.refresh()
      • RemoteDandiset.set_metadata()
      • RemoteDandiset.set_raw_metadata()
      • RemoteDandiset.upload_raw_asset()
      • RemoteDandiset.version
      • RemoteDandiset.version_api_path
      • RemoteDandiset.version_api_url
      • RemoteDandiset.version_id
      • RemoteDandiset.wait_until_valid()
    • Version
      • Version.asset_count
      • Version.created
      • Version.identifier
      • Version.json_dict()
      • Version.model_computed_fields
      • Version.model_config
      • Version.model_fields
      • Version.modified
      • Version.name
      • Version.size
      • Version.status
    • VersionInfo
      • VersionInfo.asset_validation_errors
      • VersionInfo.model_computed_fields
      • VersionInfo.model_config
      • VersionInfo.model_fields
      • VersionInfo.version_validation_errors
    • RemoteValidationError
      • RemoteValidationError.field
      • RemoteValidationError.json_dict()
      • RemoteValidationError.message
      • RemoteValidationError.model_computed_fields
      • RemoteValidationError.model_config
      • RemoteValidationError.model_fields
  • Assets
    • BaseRemoteAsset
      • BaseRemoteAsset.api_path
      • BaseRemoteAsset.api_url
      • BaseRemoteAsset.asset_type
      • BaseRemoteAsset.base_download_url
      • BaseRemoteAsset.client
      • BaseRemoteAsset.created
      • BaseRemoteAsset.digest_type
      • BaseRemoteAsset.download()
      • BaseRemoteAsset.from_base_data()
      • BaseRemoteAsset.get_content_url()
      • BaseRemoteAsset.get_digest()
      • BaseRemoteAsset.get_download_file_iter()
      • BaseRemoteAsset.get_metadata()
      • BaseRemoteAsset.get_raw_digest()
      • BaseRemoteAsset.get_raw_metadata()
      • BaseRemoteAsset.identifier
      • BaseRemoteAsset.json_dict()
      • BaseRemoteAsset.model_computed_fields
      • BaseRemoteAsset.model_config
      • BaseRemoteAsset.model_fields
      • BaseRemoteAsset.model_post_init()
      • BaseRemoteAsset.modified
      • BaseRemoteAsset.path
      • BaseRemoteAsset.size
    • BaseRemoteBlobAsset
      • BaseRemoteBlobAsset.as_readable()
      • BaseRemoteBlobAsset.asset_type
      • BaseRemoteBlobAsset.blob
      • BaseRemoteBlobAsset.model_computed_fields
      • BaseRemoteBlobAsset.model_config
      • BaseRemoteBlobAsset.model_fields
      • BaseRemoteBlobAsset.model_post_init()
    • AssetType
      • AssetType.BLOB
      • AssetType.ZARR
    • RemoteAsset
      • RemoteAsset.api_path
      • RemoteAsset.api_url
      • RemoteAsset.dandiset_id
      • RemoteAsset.delete()
      • RemoteAsset.download_url
      • RemoteAsset.from_data()
      • RemoteAsset.model_computed_fields
      • RemoteAsset.model_config
      • RemoteAsset.model_fields
      • RemoteAsset.model_post_init()
      • RemoteAsset.rename()
      • RemoteAsset.set_metadata()
      • RemoteAsset.set_raw_metadata()
      • RemoteAsset.version_id
    • RemoteBlobAsset
      • RemoteBlobAsset.client
      • RemoteBlobAsset.created
      • RemoteBlobAsset.dandiset_id
      • RemoteBlobAsset.identifier
      • RemoteBlobAsset.model_computed_fields
      • RemoteBlobAsset.model_config
      • RemoteBlobAsset.model_fields
      • RemoteBlobAsset.model_post_init()
      • RemoteBlobAsset.modified
      • RemoteBlobAsset.path
      • RemoteBlobAsset.set_raw_metadata()
      • RemoteBlobAsset.size
      • RemoteBlobAsset.version_id
    • Zarr Assets
      • BaseRemoteZarrAsset
        • BaseRemoteZarrAsset.asset_type
        • BaseRemoteZarrAsset.get_entry_by_path()
        • BaseRemoteZarrAsset.iterfiles()
        • BaseRemoteZarrAsset.model_computed_fields
        • BaseRemoteZarrAsset.model_config
        • BaseRemoteZarrAsset.model_fields
        • BaseRemoteZarrAsset.model_post_init()
        • BaseRemoteZarrAsset.rmfiles()
        • BaseRemoteZarrAsset.zarr
      • RemoteZarrAsset
        • RemoteZarrAsset.client
        • RemoteZarrAsset.created
        • RemoteZarrAsset.dandiset_id
        • RemoteZarrAsset.identifier
        • RemoteZarrAsset.model_computed_fields
        • RemoteZarrAsset.model_config
        • RemoteZarrAsset.model_fields
        • RemoteZarrAsset.model_post_init()
        • RemoteZarrAsset.modified
        • RemoteZarrAsset.path
        • RemoteZarrAsset.set_raw_metadata()
        • RemoteZarrAsset.size
        • RemoteZarrAsset.version_id
      • RemoteZarrEntry
        • RemoteZarrEntry.client
        • RemoteZarrEntry.digest
        • RemoteZarrEntry.get_download_file_iter()
        • RemoteZarrEntry.match()
        • RemoteZarrEntry.modified
        • RemoteZarrEntry.name
        • RemoteZarrEntry.parts
        • RemoteZarrEntry.size
        • RemoteZarrEntry.stem
        • RemoteZarrEntry.suffix
        • RemoteZarrEntry.suffixes
        • RemoteZarrEntry.zarr_id
• dandi.files
  • BIDSAsset
    • BIDSAsset.bids_dataset_description
    • BIDSAsset.bids_dataset_description_ref
    • BIDSAsset.bids_path
    • BIDSAsset.bids_root
    • BIDSAsset.get_metadata()
    • BIDSAsset.get_validation_bids_version()
    • BIDSAsset.get_validation_errors()
  • BIDSDatasetDescriptionAsset
    • BIDSDatasetDescriptionAsset.bids_root
    • BIDSDatasetDescriptionAsset.dataset_files
    • BIDSDatasetDescriptionAsset.get_validation_errors()
  • DandiFile
    • DandiFile.dandiset_path
    • DandiFile.filepath
    • DandiFile.get_metadata()
    • DandiFile.get_validation_errors()
    • DandiFile.modified
    • DandiFile.size
  • DandisetMetadataFile
    • DandisetMetadataFile.as_readable()
    • DandisetMetadataFile.dandiset_path
    • DandisetMetadataFile.filepath
    • DandisetMetadataFile.get_metadata()
    • DandisetMetadataFile.get_validation_errors()
  • GenericAsset
    • GenericAsset.path
  • GenericBIDSAsset
    • GenericBIDSAsset.bids_dataset_description_ref
    • GenericBIDSAsset.dandiset_path
    • GenericBIDSAsset.filepath
    • GenericBIDSAsset.get_validation_errors()
    • GenericBIDSAsset.path
  • LocalAsset
    • LocalAsset.get_digest()
    • LocalAsset.get_metadata()
    • LocalAsset.get_validation_errors()
    • LocalAsset.iter_upload()
    • LocalAsset.path
    • LocalAsset.upload()
  • LocalDirectoryAsset
    • LocalDirectoryAsset.dandiset_path
    • LocalDirectoryAsset.filepath
    • LocalDirectoryAsset.filetree
    • LocalDirectoryAsset.iterfiles()
    • LocalDirectoryAsset.path
    • LocalDirectoryAsset.size
  • LocalFileAsset
    • LocalFileAsset.as_readable()
    • LocalFileAsset.dandiset_path
    • LocalFileAsset.filepath
    • LocalFileAsset.get_digest()
    • LocalFileAsset.get_metadata()
    • LocalFileAsset.iter_upload()
    • LocalFileAsset.path
  • LocalZarrEntry
    • LocalZarrEntry.exists()
    • LocalZarrEntry.filepath
    • LocalZarrEntry.get_digest()
    • LocalZarrEntry.is_dir()
    • LocalZarrEntry.is_file()
    • LocalZarrEntry.iterdir()
    • LocalZarrEntry.modified
    • LocalZarrEntry.parent
    • LocalZarrEntry.size
    • LocalZarrEntry.zarr_basepath
  • NWBAsset
    • NWBAsset.dandiset_path
    • NWBAsset.filepath
    • NWBAsset.get_metadata()
    • NWBAsset.get_validation_errors()
    • NWBAsset.path
  • NWBBIDSAsset
    • NWBBIDSAsset.bids_dataset_description_ref
    • NWBBIDSAsset.dandiset_path
    • NWBBIDSAsset.filepath
    • NWBBIDSAsset.get_metadata()
    • NWBBIDSAsset.get_validation_errors()
    • NWBBIDSAsset.path
  • VideoAsset
    • VideoAsset.dandiset_path
    • VideoAsset.filepath
    • VideoAsset.path
  • ZarrAsset
    • ZarrAsset.dandiset_path
    • ZarrAsset.filepath
    • ZarrAsset.filetree
    • ZarrAsset.get_digest()
    • ZarrAsset.get_metadata()
    • ZarrAsset.get_validation_errors()
    • ZarrAsset.iter_upload()
    • ZarrAsset.path
    • ZarrAsset.stat()
  • ZarrBIDSAsset
    • ZarrBIDSAsset.dandiset_path
    • ZarrBIDSAsset.filepath
    • ZarrBIDSAsset.get_metadata()
    • ZarrBIDSAsset.get_validation_errors()
    • ZarrBIDSAsset.path
  • ZarrStat
    • ZarrStat.digest
    • ZarrStat.files
    • ZarrStat.size
  • dandi_file()
  • find_bids_dataset_description()
  • find_dandi_files()
• dandi.misctypes
  • BasePath
    • BasePath.exists()
    • BasePath.is_dir()
    • BasePath.is_file()
    • BasePath.is_root()
    • BasePath.iterdir()
    • BasePath.joinpath()
    • BasePath.match()
    • BasePath.name
    • BasePath.parent
    • BasePath.parents
    • BasePath.parts
    • BasePath.root_path
    • BasePath.size
    • BasePath.stem
    • BasePath.suffix
    • BasePath.suffixes
    • BasePath.with_name()
    • BasePath.with_stem()
    • BasePath.with_suffix()
  • DUMMY_DANDI_ETAG
  • Digest
    • Digest.algorithm
    • Digest.asdict()
    • Digest.dandi_etag()
    • Digest.dandi_zarr()
    • Digest.value
  • LocalReadableFile
    • LocalReadableFile.filepath
    • LocalReadableFile.get_filename()
    • LocalReadableFile.get_mtime()
    • LocalReadableFile.get_size()
    • LocalReadableFile.open()
  • Readable
    • Readable.get_filename()
    • Readable.get_mtime()
    • Readable.get_size()
    • Readable.open()
  • RemoteReadableAsset
    • RemoteReadableAsset.get_filename()
    • RemoteReadableAsset.get_mtime()
    • RemoteReadableAsset.get_size()
    • RemoteReadableAsset.open()
    • RemoteReadableAsset.url

Support functionality

• dandi.consts
  • DANDISET_ID_REGEX
  • DRAFT
  • DandiInstance
    • DandiInstance.api
    • DandiInstance.gui
    • DandiInstance.name
    • DandiInstance.redirector
    • DandiInstance.urls()
  • EmbargoStatus
    • EmbargoStatus.EMBARGOED
    • EmbargoStatus.OPEN
    • EmbargoStatus.UNEMBARGOING
  • MAX_CHUNK_SIZE
  • MAX_ZARR_DEPTH
  • PUBLISHED_VERSION_REGEX
  • RETRY_STATUSES
  • VERSION_REGEX
  • ZARR_DELETE_BATCH_SIZE
  • ZARR_MIME_TYPE
  • ZARR_UPLOAD_BATCH_SIZE
  • metadata_nwb_file_fields
• dandi.utils
  • Hasher
    • Hasher.hexdigest()
    • Hasher.update()
  • Parallel()
  • ServerInfo
    • ServerInfo.cli_bad_versions
    • ServerInfo.cli_minimal_version
    • ServerInfo.model_computed_fields
    • ServerInfo.model_config
    • ServerInfo.model_fields
    • ServerInfo.services
    • ServerInfo.version
  • ServerServices
    • ServerServices.api
    • ServerServices.jupyterhub
    • ServerServices.model_computed_fields
    • ServerServices.model_config
    • ServerServices.model_fields
    • ServerServices.webui
  • ServiceURL
    • ServiceURL.model_computed_fields
    • ServiceURL.model_config
    • ServiceURL.model_fields
    • ServiceURL.url
  • abbrev_prompt()
  • check_dandi_version()
  • chunked()
  • copy_file()
  • delayed()
  • ensure_datetime()
  • ensure_strtime()
  • exclude_from_zarr()
  • find_files()
  • find_parent_directory_containing()
  • flatten()
  • flattened()
  • fromisoformat()
  • get_instance()
  • get_mime_type()
  • get_module_version()
  • get_utcnow_datetime()
  • is_interactive()
  • is_page2_url()
  • is_same_time()
  • is_url()
  • joinurl()
  • list_paths()
  • load_jsonl()
  • move_file()
  • path_is_subpath()
  • pluralize()
  • post_upload_size_check()
  • pre_upload_size_check()
  • setup_exceptionhook()
  • shortened_repr()
  • under_paths()
  • with_pathsep()
  • yaml_dump()
  • yaml_load()
• dandi.support.digests
  • Digester
    • Digester.blocksize
    • Digester.digest_funcs
    • Digester.digests
  • checksum_zarr_dir()
  • get_dandietag()
  • get_digest()
  • get_zarr_checksum()
  • md5file_nocache()

Test infrastructure

tests.fixtures
tests.skip	Define skipif and mark namespaces for custom pytest skippers.