pybricks package

pybricks.client module

pybricks.clusters module

class pybricks.clusters.ClustersApi(hostname, token)

Bases: object

The Clusters API

pybricks.dbfs module

class pybricks.dbfs.DbfsApi(hostname, token)

Bases: object

The DBFS API

pybricks.groups module

class pybricks.groups.GroupsApi(hostname, token)

Bases: object

The Groups API

add_member(user_or_group, group_name)

Adds a user or group to a group.

create(group_name)

Creates a new group with the given name.

delete(group_name)

Removes a group from this organization.

exists(group_name)

Returns true if the group exists. False otherwise

get_members(group_name)

Returns all of the members of a particular group.

list()

Returns all of the groups in an organization.

remove_member(user_or_group, group_name)

Removes a user or group from a group.

pybricks.jobs module

class pybricks.jobs.JobsApi(hostname, token)

Bases: object

The Jobs API

get(job_id)

Retrieves information about a single job.

get_by_name(job_name)

Retrieves information about a single job by name.

list()

Lists all jobs.

run_now(job_id, notebook_params)

Runs the job now, and returns the run_id of the triggered run.

Parameters:

• job_id – The job id INT number
• notebook_params – A map from keys to values for jobs with notebook task, e.g. “notebook_params”: {“name”: “john doe”, “age”: “35”}

Returns:

runs_list(job_id, active_only=True)

Lists runs from most recently started to least.

pybricks.libraries module

class pybricks.libraries.LibrariesApi(hostname, token)

Bases: object

The Libraries API

pybricks.scim module

class pybricks.scim.ScimApi(hostname, token)

Bases: object

The SCIM, or System for Cross-domain Identity Management API

get_users()

Retrieve a list of all users in the Databricks workspace.

pybricks.secrets module

class pybricks.secrets.SecretsApi(hostname, token)

Bases: object

The Secrets API

create_scope(scope, initial_manage_principal='users')

Creates a new secret scope.

list(scope)

Lists the secret keys that are stored at this scope.

put(scope, key, string_value)

scopes_list()

Lists all secret scopes available in the workspace.

pybricks.token module

class pybricks.token.TokenApi(hostname, token)

Bases: object

The Tokens API

pybricks.workspace module