Python API¶
High-level user interfaces¶
Such interfaces mirror Command-Line Interfaces.
Mid-level user interfaces¶
These interfaces provide object-oriented interfaces to manipulate Dandisets and assets in the archive.
Low-level user interfaces¶
Low level interfaces to e.g. interact with archive REST API interfaces and files directly.
dandi.dandiapi- Client
RESTFullAPIClientDandiAPIClientDandiAPIClient.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_sizeDandiAPIClient.page_workers
- 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_computed_fieldsBaseRemoteAsset.model_configBaseRemoteAsset.model_fieldsBaseRemoteAsset.model_post_init()BaseRemoteAsset.modifiedBaseRemoteAsset.pathBaseRemoteAsset.size
BaseRemoteBlobAssetAssetTypeRemoteAssetRemoteAsset.api_pathRemoteAsset.api_urlRemoteAsset.dandiset_idRemoteAsset.delete()RemoteAsset.download_urlRemoteAsset.from_data()RemoteAsset.model_computed_fieldsRemoteAsset.model_configRemoteAsset.model_fieldsRemoteAsset.model_post_init()RemoteAsset.rename()RemoteAsset.set_metadata()RemoteAsset.set_raw_metadata()RemoteAsset.version_id
RemoteBlobAssetRemoteBlobAsset.clientRemoteBlobAsset.createdRemoteBlobAsset.dandiset_idRemoteBlobAsset.identifierRemoteBlobAsset.model_computed_fieldsRemoteBlobAsset.model_configRemoteBlobAsset.model_fieldsRemoteBlobAsset.model_post_init()RemoteBlobAsset.modifiedRemoteBlobAsset.pathRemoteBlobAsset.set_raw_metadata()RemoteBlobAsset.sizeRemoteBlobAsset.version_id
- Zarr Assets
BaseRemoteZarrAssetBaseRemoteZarrAsset.asset_typeBaseRemoteZarrAsset.get_entry_by_path()BaseRemoteZarrAsset.iterfiles()BaseRemoteZarrAsset.model_computed_fieldsBaseRemoteZarrAsset.model_configBaseRemoteZarrAsset.model_fieldsBaseRemoteZarrAsset.model_post_init()BaseRemoteZarrAsset.rmfiles()BaseRemoteZarrAsset.zarr
RemoteZarrAssetRemoteZarrAsset.clientRemoteZarrAsset.createdRemoteZarrAsset.dandiset_idRemoteZarrAsset.identifierRemoteZarrAsset.model_computed_fieldsRemoteZarrAsset.model_configRemoteZarrAsset.model_fieldsRemoteZarrAsset.model_post_init()RemoteZarrAsset.modifiedRemoteZarrAsset.pathRemoteZarrAsset.set_raw_metadata()RemoteZarrAsset.sizeRemoteZarrAsset.version_id
RemoteZarrEntry
- Client
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()ServerInfoServerServicesServiceURLabbrev_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
Test infrastructure¶
Define |