quartzbio.resource.vault module

QuartzBio Vault API resource

class quartzbio.resource.vault.Vault(vault_id, **kwargs)

Bases: CreateableAPIResource, ListableAPIResource, DeletableAPIResource, SearchableAPIResource, UpdateableAPIResource

A vault is like a filesystem that can contain files, folder, and QuartzBio datasets. Vaults can be “connected” to external resources such as Amazon S3 Buckets. Typically, vaults contain a series of datasets that are compatible with each other (i.e. they come from the same data source or project).

LIST_FIELDS = (('id', 'ID'), ('full_path', 'Full Path'), ('provider', 'Provider'), ('description', 'Description'))

RESOURCE_VERSION = 2

VAULT_PATH_RE = re.compile('^(?:(?P<domain>[a-zA-Z0-9\\-]+)\\:)??(?P<vault>[^\\/:]+)(?:\\:?\\/.*)?$')

create_dataset(name, **params)

create_folder(filename, **params)

datasets(**params)

disable_versioning()

enable_versioning()

files(**params)

folders(**params)

classmethod get_by_full_path(full_path, **kwargs)

classmethod get_or_create_by_full_path(full_path, **kwargs)

classmethod get_or_create_uploads_path(**kwargs)

classmethod get_personal_vault(**kwargs)

ls(**params)

objects(**params)

search(query, **params)

suspend_versioning()

upload_file(local_path, remote_path, **kwargs)

classmethod validate_full_path(full_path, **kwargs)

Helper method to return a full path from a full or partial path.

If no domain, assumes user’s account domain If the vault is “~”, assumes personal vault.

Valid vault paths include:

domain:vault domain:vault:/path domain:vault/path vault:/path vault ~/

Invalid vault paths include:

/vault/ /path / :/

Does not allow overrides for any vault path components.