Python API¶
High-level user interfaces¶
Such interfaces mirror Command-Line Interfaces.
Delete assets and dandisets from DANDI Archive. |
|
Download assets from DANDI Archive. |
|
Move and rename assets in DANDI Archive. |
|
Organize and structure NWB files according to DANDI conventions. |
|
Upload assets to DANDI Archive. |
|
Validation of DANDI datasets against schemas and standards. |
Mid-level user interfaces¶
Object-oriented interfaces to manipulate Dandisets and assets on a DANDI instance.
Low-level user interfaces¶
Low level interfaces to e.g. interact with the DANDI REST API and files directly.
dandi.dandiapi- Client
- Dandisets
RemoteDandisetRemoteDandiset.api_pathRemoteDandiset.api_urlRemoteDandiset.clientRemoteDandiset.contact_personRemoteDandiset.createdRemoteDandiset.delete()RemoteDandiset.download_directory()RemoteDandiset.draft_versionRemoteDandiset.embargo_statusRemoteDandiset.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.identifierRemoteDandiset.iter_upload_raw_asset()RemoteDandiset.json_dict()RemoteDandiset.modifiedRemoteDandiset.most_recent_published_versionRemoteDandiset.publish()RemoteDandiset.refresh()RemoteDandiset.set_metadata()RemoteDandiset.set_raw_metadata()RemoteDandiset.upload_raw_asset()RemoteDandiset.versionRemoteDandiset.version_api_pathRemoteDandiset.version_api_urlRemoteDandiset.version_idRemoteDandiset.wait_until_valid()
VersionVersionInfoRemoteValidationError
- Assets
BaseRemoteAssetBaseRemoteAsset.api_pathBaseRemoteAsset.api_urlBaseRemoteAsset.asset_typeBaseRemoteAsset.base_download_urlBaseRemoteAsset.clientBaseRemoteAsset.createdBaseRemoteAsset.digest_typeBaseRemoteAsset.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.identifierBaseRemoteAsset.json_dict()BaseRemoteAsset.model_configBaseRemoteAsset.model_post_init()BaseRemoteAsset.modifiedBaseRemoteAsset.pathBaseRemoteAsset.size
BaseRemoteBlobAssetAssetTypeRemoteAssetRemoteBlobAsset- Zarr Assets
BaseRemoteZarrAssetRemoteZarrAssetRemoteZarrEntryRemoteZarrEntry.clientRemoteZarrEntry.digestRemoteZarrEntry.download_urlRemoteZarrEntry.get_download_file_iter()RemoteZarrEntry.match()RemoteZarrEntry.modifiedRemoteZarrEntry.nameRemoteZarrEntry.partsRemoteZarrEntry.sizeRemoteZarrEntry.stemRemoteZarrEntry.suffixRemoteZarrEntry.suffixesRemoteZarrEntry.zarr_id
dandi.filesdandi.misctypesBasePathBasePath.exists()BasePath.is_dir()BasePath.is_file()BasePath.is_root()BasePath.iterdir()BasePath.joinpath()BasePath.match()BasePath.nameBasePath.parentBasePath.parentsBasePath.partsBasePath.root_pathBasePath.sizeBasePath.stemBasePath.suffixBasePath.suffixesBasePath.with_name()BasePath.with_stem()BasePath.with_suffix()
DUMMY_DANDI_ETAGDigestLocalReadableFileReadableRemoteReadableAsset
Support functionality¶
dandi.constsdandi.utilsHasherParallel()ServerInfoServerServicesServiceURLStrEnumabbrev_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_retry_after()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
Test infrastructure¶
Define |