siibra.retrieval.repositories
Connect to repositories to browse and pull files within.
Classes
Download sensitive files from EBRAINS using |
|
Access files from public EBRAINS datasets via the Knowledge Graph v3 API. |
|
Access files from public EBRAINS datasets via the Knowledge Graph v3 API. |
|
Base class for repository connectors. |
|
Base class for repository connectors. |
|
Base class for repository connectors. |
|
Base class for repository connectors. |
|
Base class for repository connectors. |
|
Base class for repository connectors. |
Module Contents
- class siibra.retrieval.repositories.EbrainsHdgConnector(dataset_id)
Download sensitive files from EBRAINS using the Human Data Gateway (HDG) via the data proxy API. Service documentation can be found here https://data-proxy.ebrains.eu/api/docs
- get_loader(filename, folder='', decode_func=None)
Get a lazy loader for a file, for executing the query only once loader.data is accessed.
- search_files(folder='', suffix=None, recursive=False)
Get the files within the repository.
- api_version = 'v1'
Base URL for the Dataset Endpoint of the Data-Proxy API https://data-proxy.ebrains.eu/api/docs#/datasets
Supported functions by the endpoint:
- POST: Request access to the dataset.
This is required for the other functions.
GET: Return list of all available objects in the dataset
- base_url
Limit of returned objects Default value on API side is 50 objects
- dataset_id
- maxentries = 1000
- class siibra.retrieval.repositories.EbrainsPublicDatasetConnector(dataset_id: str = None, version_id: str = None, title: str = None, in_progress=False)
Access files from public EBRAINS datasets via the Knowledge Graph v3 API.
- get_loader(filename, folder='', decode_func=None)
Get a lazy loader for a file, for executing the query only once loader.data is accessed.
- search_files(folder='', suffix=None, recursive=False)
Get the files within the repository.
- QUERY_ID = 'bebbe365-a0d6-41ea-9ff8-2554c15f70b7'
- property authors
- base_url = 'https://core.kg.ebrains.eu/v3-beta/queries/'
- property citation
- dataset_id = None
- property description
- id
- maxentries = 1000
- property name
- use_version = None
- versions
- class siibra.retrieval.repositories.EbrainsPublicDatasetConnectorMinds(dataset_id=None, title=None, in_progress=False)
Access files from public EBRAINS datasets via the Knowledge Graph v3 API.
- get_loader(filename, folder='', decode_func=None)
Get a lazy loader for a file, for executing the query only once loader.data is accessed.
- search_files(folder='', suffix=None, recursive=False)
Get the files within the repository.
- QUERY_ID = 'siibra-minds-dataset-v1'
- base_url = 'https://kg.humanbrainproject.eu/query/minds/core/dataset/v1.0.0'
- maxentries = 1000
- class siibra.retrieval.repositories.GithubConnector(owner: str, repo: str, reftag: str, skip_branchtest=False, archive_mode=False)
Base class for repository connectors.
- get_loader(filename, folder='', decode_func=None)
Get a lazy loader for a file, for executing the query only once loader.data is accessed.
- search_files(folder='', suffix='', recursive=False) List[str]
Get the files within the repository.
- archive_mode = False
- reftag
- class siibra.retrieval.repositories.GitlabConnector(server: str, project: int, reftag: str, skip_branchtest=False, *, archive_mode=False)
Base class for repository connectors.
- __eq__(other)
- __str__()
- get_loader(filename, folder='', decode_func=None)
Get a lazy loader for a file, for executing the query only once loader.data is accessed.
- search_files(folder='', suffix=None, recursive=False)
Get the files within the repository.
- archive_mode = False
- property branches
- reftag
- property want_commit
- class siibra.retrieval.repositories.LocalFileRepository(folder: str)
Base class for repository connectors.
- __eq__(other: LocalFileRepository)
- __str__()
- get_loader(filename, folder='', decode_func=None)
Get a lazy loader for a file, for loading data only once loader.data is accessed.
- search_files(folder='', suffix=None, recursive=False)
Get the files within the repository.
- class siibra.retrieval.repositories.OwncloudConnector(server: str, share: int)
Base class for repository connectors.
- abstract search_files(folder='', suffix=None, recursive=False)
Get the files within the repository.
- class siibra.retrieval.repositories.RepositoryConnector(base_url)
Base class for repository connectors.
- __eq__(other)
- get(filename, folder='', decode_func=None)
Get a file right away.
- get_loader(filename, folder='', decode_func=None)
Get a lazy loader for a file, for executing the query only once loader.data is accessed.
- get_loaders(folder='', suffix=None, progress=None, recursive=False, decode_func=None)
Returns an iterator with lazy loaders for the files in a given folder. In each iteration, a tuple (filename,file content) is returned.
- abstract search_files(folder: str, suffix: str, recursive: bool = False) List[str]
Get the files within the repository.
- base_url
- class siibra.retrieval.repositories.ZipfileConnector(url: str)
Base class for repository connectors.
- class ZipFileLoader(zipfile, filename, decode_func)
Loads a file from the zip archive, but mimics the behaviour of cached http requests used in other connectors.
- property cached
- cachefile
- property data
- filename
- func
- zipfile
- __eq__(other)
- __str__()
- clear_cache()
- get_loader(filename, folder='', decode_func=None)
Get a lazy loader for a file, for loading data only once loader.data is accessed.
- search_files(folder='', suffix='', recursive=False)
Get the files within the repository.
- url
- property zipfile