datacatalog.tenancy package¶

Submodules¶

datacatalog.tenancy.classes module¶

class datacatalog.tenancy.classes.TenantURL[source]¶

Bases: str

TACC.cloud tenant base URL

class datacatalog.tenancy.classes.TenantName[source]¶

Bases: str

TACC.cloud tenant name

class datacatalog.tenancy.classes.ProjectName[source]¶

Bases: str

TACC.cloud project name

class datacatalog.tenancy.classes.Username[source]¶

Bases: str

TACC.cloud username

datacatalog.tenancy.funcs module¶

datacatalog.tenancy.funcs.current_username()[source]¶

Retrieve the current TACC.cloud username

Returns:	current username
Return type:	Username
Raises:	`ValueError` – This is raised on failure to find a username

datacatalog.tenancy.funcs.current_tenant()[source]¶

Retrieve the current TACC.cloud tenant

Returns:	current tenant name
Return type:	TenantName

datacatalog.tenancy.funcs.current_tenant_uri()[source]¶

Retrieve the current TACC.cloud tenant

Returns:	current tenant base URI
Return type:	TenantURL

datacatalog.tenancy.funcs.current_project()[source]¶

Retrieve the current TACC.cloud project

Returns:	current project name
Return type:	ProjectName

datacatalog.tenancy.funcs.current_admin_username()[source]¶

Retrieve the TACC.cloud tenant admin username

Returns:	tenant admin username
Return type:	Username

datacatalog.tenancy.projects module¶

class datacatalog.tenancy.projects.Project(*args, **kwargs)[source]¶: Bases: attrdict.dictionary.AttrDict

class datacatalog.tenancy.projects.Projects[source]¶

Bases: object

names()[source]¶: Return the property-named list of projects

project_names()[source]¶: Return a sorted list of project identifiers

classmethod sync()[source]¶: Fetch the current set of Data Catalog projects

validate_project_id(project_id, permissive=True)[source]¶: Validate the supplied string against known project identifiers

datacatalog.tenancy.schemas module¶

class datacatalog.tenancy.schemas.ProjectNameSchema(**kwargs)[source]¶

Bases: datacatalog.jsonschemas.schema.JSONSchemaBaseObject

Schema document enumerating all ProjectNames

class datacatalog.tenancy.schemas.TenantIdSchema(**kwargs)[source]¶

Bases: datacatalog.jsonschemas.schema.JSONSchemaBaseObject

Schema document enumerating all TenantIds

datacatalog.tenancy.schemas.get_project_name_schema()[source]¶

datacatalog.tenancy.schemas.get_schemas()[source]¶

Returns the filetype_label subschema

Returns:	One or more schema documents
Return type:	JSONSchemaCollection

datacatalog.tenancy.schemas.get_tenant_id_schema()[source]¶

datacatalog.tenancy.tenants module¶

class datacatalog.tenancy.tenants.Tenant(*args, **kwargs)[source]¶: Bases: attrdict.dictionary.AttrDict

class datacatalog.tenancy.tenants.Tenants[source]¶

Bases: object

names()[source]¶: Return the property-named list of tenants

classmethod sync()[source]¶: Fetch the current set of Tapis tenants

tenant_ids()[source]¶: Return a sorted list of tenant identifiers

validate_tenant_id(tenant_id, permissive=True)[source]¶: Validate the supplied string against known tenant identifiers