swh.vault.api package

Submodules

swh.vault.api.client module

exception swh.vault.api.client.VaultAPIError[source]

Bases: Exception

Vault API Error

class swh.vault.api.client.RemoteVaultClient(base_url, timeout=None)[source]

Bases: swh.core.api.SWHRemoteAPI

Client to the Software Heritage vault cache.

fetch(obj_type, obj_id)[source]
cook(obj_type, obj_id, email=None)[source]
progress(obj_type, obj_id)[source]
set_progress(obj_type, obj_id, progress)[source]
set_status(obj_type, obj_id, status)[source]
put_bundle(obj_type, obj_id, bundle)[source]
send_notif(obj_type, obj_id)[source]
batch_cook(batch)[source]
batch_progress(batch_id)[source]

swh.vault.api.server module

swh.vault.api.server.index(request)[source]
swh.vault.api.server.vault_fetch(request)[source]
swh.vault.api.server.user_info(task_info)[source]
swh.vault.api.server.vault_cook(request)[source]
swh.vault.api.server.vault_progress(request)[source]
swh.vault.api.server.set_progress(request)[source]
swh.vault.api.server.set_status(request)[source]
swh.vault.api.server.put_bundle(request)[source]
swh.vault.api.server.send_notif(request)[source]
swh.vault.api.server.batch_cook(request)[source]
swh.vault.api.server.batch_progress(request)[source]
swh.vault.api.server.make_app(config, **kwargs)[source]
swh.vault.api.server.make_app_from_configfile(config_path='vault/server', **kwargs)[source]

Module contents