DomoJupyter Integration

auth = dmda.DomoTokenAuth(
    domo_instance=os.environ["DOMO_DOJO_INSTANCE"],
    domo_access_token=os.environ["DOMO_DOJO_ACCESS_TOKEN"],
)

JUPYTER_TOKEN = "OT98Xy8sePH894pA7SgUhjEcjk1kHK"
WORKSPACE_ID = "1cfe9db4-5937-4889-beb3-a311fc42f246"  # learn_jupyter

workspace_params = await get_workspace_auth_token_params(
    workspace_id=WORKSPACE_ID, auth=auth
)

dj_auth = dmda.DomoJupyterTokenAuth.convert_auth(
    auth=auth, jupyter_token=JUPYTER_TOKEN, **workspace_params
)

dj_auth

DomoJupyterTokenAuth(jupyter_token='OT98Xy8sePH894pA7SgUhjEcjk1kHK', service_location='jupyter-prod1.domodatascience.com', service_prefix='/user/domo-community-1893952720/1cfe9db4/', domo_instance='domo-community', url_manual_login='https://domo-community.domo.com/auth/index?domoManualLogin=true', token_name='token_auth', user_id=1893952720, is_valid_token=True)

DomoJupyerWorkspace Class

Get and Search

---

source

DomoJupyterWorkspace

 DomoJupyterWorkspace (auth:domolibrary.client.DomoAuth.DomoJupyterAuth,
                       id:str, name:str, description:str,
                       created_dt:datetime.datetime,
                       updated_dt:datetime.datetime, owner:dict, cpu:str,
                       memory:int, last_run_dt:datetime.datetime=None,
                       instances:List[dict]=None, input_configuration:List
                       [domolibrary.classes.DomoJupyter_DataSource.DomoJup
                       yter_DataSource]=<factory>, output_configuration:Li
                       st[domolibrary.classes.DomoJupyter_DataSource.DomoJ
                       upyter_DataSource]=<factory>, account_configuration
                       :List[domolibrary.classes.DomoJupyter_Account.DomoJ
                       upyter_Account]=<factory>, content:List[domolibrary
                       .classes.DomoJupyter_Content.DomoJupyter_Content]=<
                       factory>, collection_configuration:List[dict]=None,
                       fileshare_configuration:List[dict]=None,
                       service_location:str=None, service_prefix:str=None)

---

source

DJW_InvalidClass

 DJW_InvalidClass (cls_instance, message)

base exception

---

source

DJW_Search_Error

 DJW_Search_Error (cls=None, cls_instance=None, search_name=None,
                   message=None, domo_instance=None)

base exception

djw = await DomoJupyterWorkspace.get_by_id(
    workspace_id=WORKSPACE_ID, auth=auth, jupyter_token=JUPYTER_TOKEN
)

djw

DomoJupyterWorkspace(id='1cfe9db4-5937-4889-beb3-a311fc42f246', name='learn_jupyter', description='', created_dt='2024-02-22T17:13:54.653+00:00', updated_dt='2025-03-11T14:53:08.093+00:00', owner=1893952720, cpu=4.0, memory=32.0, last_run_dt='2025-03-11T14:53:08.093+00:00', instances=[{'started': '2025-03-11T13:33:21.647+00:00', 'lastActivity': '2025-03-11T13:49:15.937+00:00', 'url': 'https://domo-community.jupyter-prod1.domodatascience.com/hub/auth_refresh?domo_hostname=https%3A%2F%2Fdomo-community.domo.com&next=https%3A%2F%2Fdomo-community.jupyter-prod1.domodatascience.com%2Fuser%2Fdomo-community-1893952720%2F1cfe9db4%2F', 'status': 'RUNNING', 'userId': 1893952720}], input_configuration=[], output_configuration=[DomoJupyter_DataSource(dataset_id='84658e41-924e-499c-987b-f82dc10163cc', alias='DomoStats - Accounts', is_exists=True, domo_dataset=DomoDataset(id='84658e41-924e-499c-987b-f82dc10163cc', display_type='domo-jupyterdata', data_provider_type='domo-jupyterdata', name='DomoStats - Accounts', description=None, row_count=14, column_count=5, stream_id=1375, owner={'id': '1893952720', 'name': 'Jae Wilson1', 'type': 'USER', 'group': False}, formula={}, Schema=DomoDataset_Schema(dataset_id='84658e41-924e-499c-987b-f82dc10163cc', columns=[]), Stream=DomoStream(id=1375, dataset_id='84658e41-924e-499c-987b-f82dc10163cc', transport_description=None, transport_version=None, update_method=None, data_provider_name=None, data_provider_key=None, account_id=None, account_display_name=None, account_userid=None, has_mapping=False, configuration=[], configuration_tables=[], configuration_query=None), Tags=DomoTags(tag_ls=[]), PDP=<domolibrary.classes.DomoPDP.Dataset_PDP_Policies object at 0x717ec82d7e00>, Certification=None))], account_configuration=[DomoJupyter_Account(account_id=92, alias='username_password_auth', is_exists=True, domo_account=DomoAccount(id=92, name='jw_username_password_auth', data_provider_type='abstract-credential-store', created_dt=datetime.datetime(2024, 2, 22, 18, 0, 24), modified_dt=datetime.datetime(2024, 2, 22, 18, 0, 24), owners=None, is_admin_summary=False)), DomoJupyter_Account(account_id=94, alias='my_domo_community_access_token - updated 2024-02-23', is_exists=True, domo_account=DomoAccount(id=94, name='my_domo_community_access_token - updated 2024-02-23', data_provider_type='abstract-credential-store', created_dt=datetime.datetime(2024, 2, 23, 3, 8, 21), modified_dt=datetime.datetime(2024, 2, 23, 3, 8, 21), owners=None, is_admin_summary=False)), DomoJupyter_Account(account_id=100, alias='domo-community', is_exists=True, domo_account=DomoAccount_Credential(id=100, name='domo-community_NF', data_provider_type='domo-access-token', created_dt=datetime.datetime(2024, 3, 24, 0, 53, 57), modified_dt=datetime.datetime(2024, 5, 29, 15, 23, 46), owners=None, is_admin_summary=False, target_instance=None, is_valid_full_auth=None, is_valid_token_auth=None, target_auth=None, target_user=None, target_access_token=None)), DomoJupyter_Account(account_id=88, alias='fake_account', is_exists=True, domo_account=DomoAccount(id=88, name='fake_account', data_provider_type='abstract-credential-store', created_dt=datetime.datetime(2023, 12, 4, 16, 31, 59), modified_dt=datetime.datetime(2024, 6, 4, 1, 10, 24), owners=None, is_admin_summary=False))], content=[], collection_configuration=None, fileshare_configuration=[], service_location='jupyter-prod1.domodatascience.com', service_prefix='/user/domo-community-1893952720/1cfe9db4/')

await djw.get_account_configuration()

[DomoJupyter_Account(account_id=92, alias='username_password_auth', is_exists=True, domo_account=DomoAccount(id=92, name='jw_username_password_auth', data_provider_type='abstract-credential-store', created_dt=datetime.datetime(2024, 2, 22, 18, 0, 24), modified_dt=datetime.datetime(2024, 2, 22, 18, 0, 24), owners=None, is_admin_summary=False)),
 DomoJupyter_Account(account_id=94, alias='my_domo_community_access_token - updated 2024-02-23', is_exists=True, domo_account=DomoAccount(id=94, name='my_domo_community_access_token - updated 2024-02-23', data_provider_type='abstract-credential-store', created_dt=datetime.datetime(2024, 2, 23, 3, 8, 21), modified_dt=datetime.datetime(2024, 2, 23, 3, 8, 21), owners=None, is_admin_summary=False)),
 DomoJupyter_Account(account_id=100, alias='domo-community', is_exists=True, domo_account=DomoAccount_Credential(id=100, name='domo-community_NF', data_provider_type='domo-access-token', created_dt=datetime.datetime(2024, 3, 24, 0, 53, 57), modified_dt=datetime.datetime(2024, 5, 29, 15, 23, 46), owners=None, is_admin_summary=False, target_instance=None, is_valid_full_auth=None, is_valid_token_auth=None, target_auth=None, target_user=None, target_access_token=None)),
 DomoJupyter_Account(account_id=88, alias='fake_account', is_exists=True, domo_account=DomoAccount(id=88, name='fake_account', data_provider_type='abstract-credential-store', created_dt=datetime.datetime(2023, 12, 4, 16, 31, 59), modified_dt=datetime.datetime(2024, 6, 4, 1, 10, 24), owners=None, is_admin_summary=False))]

search workspaces

---

source

DomoJupyterWorkspaces

 DomoJupyterWorkspaces (auth:domolibrary.client.DomoAuth.DomoAuth,
                        workspaces:List[__main__.DomoJupyterWorkspace]=Non
                        e, parent:Any=None)

dj_workspaces = DomoJupyterWorkspaces(auth = dj_auth)
dj_workspace = None

try:
    dj_workspace = await dj_workspaces.search_workspace_by_name(
        workspace_name="learn_jupyter", debug_api=False, return_raw=False
    )
    print(dj_workspace)
except dmde.DomoError as e:
    print(e)

DomoJupyterWorkspace(id='1cfe9db4-5937-4889-beb3-a311fc42f246', name='learn_jupyter', description='', created_dt='2024-02-22T17:13:54.653+00:00', updated_dt='2025-03-11T14:53:08.093+00:00', owner=1893952720, cpu=4.0, memory=32.0, last_run_dt='2025-03-11T14:53:08.093+00:00', instances=[{'started': '2025-03-11T13:33:21.647+00:00', 'lastActivity': '2025-03-11T13:49:15.937+00:00', 'url': 'https://domo-community.jupyter-prod1.domodatascience.com/hub/auth_refresh?domo_hostname=https%3A%2F%2Fdomo-community.domo.com&next=https%3A%2F%2Fdomo-community.jupyter-prod1.domodatascience.com%2Fuser%2Fdomo-community-1893952720%2F1cfe9db4%2F', 'status': 'RUNNING', 'userId': 1893952720}], input_configuration=[], output_configuration=[DomoJupyter_DataSource(dataset_id='84658e41-924e-499c-987b-f82dc10163cc', alias='DomoStats - Accounts', is_exists=True, domo_dataset=DomoDataset(id='84658e41-924e-499c-987b-f82dc10163cc', display_type='domo-jupyterdata', data_provider_type='domo-jupyterdata', name='DomoStats - Accounts', description=None, row_count=14, column_count=5, stream_id=1375, owner={'id': '1893952720', 'name': 'Jae Wilson1', 'type': 'USER', 'group': False}, formula={}, Schema=DomoDataset_Schema(dataset_id='84658e41-924e-499c-987b-f82dc10163cc', columns=[]), Stream=DomoStream(id=1375, dataset_id='84658e41-924e-499c-987b-f82dc10163cc', transport_description=None, transport_version=None, update_method=None, data_provider_name=None, data_provider_key=None, account_id=None, account_display_name=None, account_userid=None, has_mapping=False, configuration=[], configuration_tables=[], configuration_query=None), Tags=DomoTags(tag_ls=[]), PDP=<domolibrary.classes.DomoPDP.Dataset_PDP_Policies object at 0x717ec78bfe00>, Certification=None))], account_configuration=[DomoJupyter_Account(account_id=92, alias='username_password_auth', is_exists=True, domo_account=DomoAccount(id=92, name='jw_username_password_auth', data_provider_type='abstract-credential-store', created_dt=datetime.datetime(2024, 2, 22, 18, 0, 24), modified_dt=datetime.datetime(2024, 2, 22, 18, 0, 24), owners=None, is_admin_summary=False)), DomoJupyter_Account(account_id=94, alias='my_domo_community_access_token - updated 2024-02-23', is_exists=True, domo_account=DomoAccount(id=94, name='my_domo_community_access_token - updated 2024-02-23', data_provider_type='abstract-credential-store', created_dt=datetime.datetime(2024, 2, 23, 3, 8, 21), modified_dt=datetime.datetime(2024, 2, 23, 3, 8, 21), owners=None, is_admin_summary=False)), DomoJupyter_Account(account_id=100, alias='domo-community', is_exists=True, domo_account=DomoAccount_Credential(id=100, name='domo-community_NF', data_provider_type='domo-access-token', created_dt=datetime.datetime(2024, 3, 24, 0, 53, 57), modified_dt=datetime.datetime(2024, 5, 29, 15, 23, 46), owners=None, is_admin_summary=False, target_instance=None, is_valid_full_auth=None, is_valid_token_auth=None, target_auth=None, target_user=None, target_access_token=None)), DomoJupyter_Account(account_id=88, alias='fake_account', is_exists=True, domo_account=DomoAccount(id=88, name='fake_account', data_provider_type='abstract-credential-store', created_dt=datetime.datetime(2023, 12, 4, 16, 31, 59), modified_dt=datetime.datetime(2024, 6, 4, 1, 10, 24), owners=None, is_admin_summary=False))], content=[], collection_configuration=None, fileshare_configuration=[], service_location='jupyter-prod1.domodatascience.com', service_prefix='/user/domo-community-1893952720/1cfe9db4/')

if dj_workspace:
    [print(ac) for ac in dj_workspace.account_configuration]

DomoJupyter_Account(account_id=92, alias='username_password_auth', is_exists=True, domo_account=DomoAccount(id=92, name='jw_username_password_auth', data_provider_type='abstract-credential-store', created_dt=datetime.datetime(2024, 2, 22, 18, 0, 24), modified_dt=datetime.datetime(2024, 2, 22, 18, 0, 24), owners=None, is_admin_summary=False))
DomoJupyter_Account(account_id=94, alias='my_domo_community_access_token - updated 2024-02-23', is_exists=True, domo_account=DomoAccount(id=94, name='my_domo_community_access_token - updated 2024-02-23', data_provider_type='abstract-credential-store', created_dt=datetime.datetime(2024, 2, 23, 3, 8, 21), modified_dt=datetime.datetime(2024, 2, 23, 3, 8, 21), owners=None, is_admin_summary=False))
DomoJupyter_Account(account_id=100, alias='domo-community', is_exists=True, domo_account=DomoAccount_Credential(id=100, name='domo-community_NF', data_provider_type='domo-access-token', created_dt=datetime.datetime(2024, 3, 24, 0, 53, 57), modified_dt=datetime.datetime(2024, 5, 29, 15, 23, 46), owners=None, is_admin_summary=False, target_instance=None, is_valid_full_auth=None, is_valid_token_auth=None, target_auth=None, target_user=None, target_access_token=None))
DomoJupyter_Account(account_id=88, alias='fake_account', is_exists=True, domo_account=DomoAccount(id=88, name='fake_account', data_provider_type='abstract-credential-store', created_dt=datetime.datetime(2023, 12, 4, 16, 31, 59), modified_dt=datetime.datetime(2024, 6, 4, 1, 10, 24), owners=None, is_admin_summary=False))

Modify Config

sample impelemntation of get_content

try:
    await djw.get_content()

except (JupyterAPI_Error, dmda.InvalidAuthTypeError) as e:
    print(e)

🛑  JupyterAPI_Error 🛑 - function: DomoJupyterWorkspace.get_traceback || status 403 || Forbidden at domo-community

sample implementation of updating content with DomoJupyter_Content class

test_content = None
try:
    djw_content = await djw.get_content()

    test_content = next(
        (
            content
            for content in djw_content
            if content.name.startswith("updated_") and content.folder == "new_folder/"
        )
    )
    test_content.content = (
        f"jae rocks at debugging.  he's superfly -- updated {dt.date.today()}"
    )

    print((await test_content.update(debug_api=False)).response)

except (JupyterAPI_Error, dmda.InvalidAuthTypeError) as e:
    print(e)

🛑  JupyterAPI_Error 🛑 - function: DomoJupyterWorkspace.get_traceback || status 403 || Forbidden at domo-community

sample implementation of export_content

try:
    if test_content:
        test_content.export(output_folder="../test/")

except Exception as e:
    print(e)

await dj_workspace.get_account_configuration()

[DomoJupyter_Account(account_id=92, alias='username_password_auth', is_exists=True, domo_account=DomoAccount(id=92, name='jw_username_password_auth', data_provider_type='abstract-credential-store', created_dt=datetime.datetime(2024, 2, 22, 18, 0, 24), modified_dt=datetime.datetime(2024, 2, 22, 18, 0, 24), owners=None, is_admin_summary=False)),
 DomoJupyter_Account(account_id=94, alias='my_domo_community_access_token - updated 2024-02-23', is_exists=True, domo_account=DomoAccount(id=94, name='my_domo_community_access_token - updated 2024-02-23', data_provider_type='abstract-credential-store', created_dt=datetime.datetime(2024, 2, 23, 3, 8, 21), modified_dt=datetime.datetime(2024, 2, 23, 3, 8, 21), owners=None, is_admin_summary=False)),
 DomoJupyter_Account(account_id=100, alias='domo-community', is_exists=True, domo_account=DomoAccount_Credential(id=100, name='domo-community_NF', data_provider_type='domo-access-token', created_dt=datetime.datetime(2024, 3, 24, 0, 53, 57), modified_dt=datetime.datetime(2024, 5, 29, 15, 23, 46), owners=None, is_admin_summary=False, target_instance=None, is_valid_full_auth=None, is_valid_token_auth=None, target_auth=None, target_user=None, target_access_token=None)),
 DomoJupyter_Account(account_id=88, alias='fake_account', is_exists=True, domo_account=DomoAccount(id=88, name='fake_account', data_provider_type='abstract-credential-store', created_dt=datetime.datetime(2023, 12, 4, 16, 31, 59), modified_dt=datetime.datetime(2024, 6, 4, 1, 10, 24), owners=None, is_admin_summary=False))]