regardias.api package

Submodules

regardias.api.api module

class regardias.api.api.API(instance_url: str, project_name: str, username: str, password: str, token: str | None = None)

Bases: object

A class to access Regards API

export_microservice_configuration(microservice: str, filename: PathLike | str | Path | None = None)

Export a microservice configuration to a JSON file

import_microservice_configuration(microservice: str, filename: str)

Import a microservice configuration from a JSON file

instance_url: str

logger = <Logger regardias.api.api (INFO)>

password: str

project_name: str

retrieve_token()

Retrieve a token to access the API with username/password

token: str | None = None

username: str

exception regardias.api.api.APIError

Bases: Exception

regardias.api.attribute_api module

class regardias.api.attribute_api.AttributeAPI(instance_url: str, project_name: str, username: str, password: str)

Bases: API

A class to access Regards models API

delete_all()

delete_by_id(id: int)

delete_by_name(name: str)

get_id_from_name(name: str)

exception regardias.api.attribute_api.AttributeAPIError

Bases: Exception

regardias.api.dataset_api module

class regardias.api.dataset_api.DatasetAPI(instance_url: str, project_name: str, username: str, password: str)

Bases: API

A class to access Regards datasets API

delete_all()

delete_by_id(dataset_id)

delete_by_name(dataset_name)

get_id_from_name(dataset_name)

get_list()

list_available_datasets()

exception regardias.api.dataset_api.DatasetAPIError

Bases: Exception

regardias.api.datasource_api module

regardias.api.model_api module

regardias.api.sip_api module

regardias.api.users_api module

Module contents