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
RESTFullAPIClient
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
VersionInfo
RemoteValidationError
- 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
AssetType
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
- Client
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
LocalReadableFile
Readable
RemoteReadableAsset
Support functionality¶
dandi.consts
dandi.utils
Hasher
Parallel()
ServerInfo
ServerServices
ServiceURL
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
Test infrastructure¶
Define |