Skip to content

config

get_resolved_secrets(syncsk_server_config)

Get resolved secrets from the server config.

Parameters:

Name Type Description Default
syncsk_server_config dict

The server config dict.

required

Returns:

Name Type Description
dict

The resolved secrets.

Source code in syncsketch_common/config.py
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
def get_resolved_secrets(syncsk_server_config):
    """ Get resolved secrets from the server config.

    Args:
        syncsk_server_config (dict): The server config dict.

    Returns:
        dict: The resolved secrets.
    """
    all_secrets = ayon_api.get_secrets()
    secrets = {secret["name"]: secret["value"] for secret in all_secrets}

    # resolve all secrets from the server config
    resolved_secrets = {
        key_: secrets[syncsk_server_config[key_]]
        for key_ in required_secret_keys
        if syncsk_server_config[key_] in secrets
    }

    return resolved_secrets

get_syncsketch_project_config(project_name, addon_version)

Returns the active SyncSketch config for the current project

Parameters:

Name Type Description Default
project_name str

name of the project

required
addon_version str

version of the addon

required

Returns:

Name Type Description
dict

SyncSketch config

Source code in syncsketch_common/config.py
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
def get_syncsketch_project_config(project_name, addon_version):
    """Returns the active SyncSketch config for the current project

    Args:
        project_name (str): name of the project
        addon_version (str): version of the addon

    Returns:
        dict: SyncSketch config
    """
    project_settings = get_addon_project_settings(
        "syncsketch",
        addon_version,
        project_name
    )

    return project_settings["syncsketch_server_config"]

merge_resolved_secrets(syncsk_server_config)

Merge resolved secrets into server config.

Parameters:

Name Type Description Default
syncsk_server_config dict

The server config dict.

required

Returns:

Name Type Description
dict

The resolved secrets.

Source code in syncsketch_common/config.py
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def merge_resolved_secrets(syncsk_server_config):
    """ Merge resolved secrets into server config.

    Args:
        syncsk_server_config (dict): The server config dict.

    Returns:
        dict: The resolved secrets.
    """
    resolved_secrets = get_resolved_secrets(syncsk_server_config)

    # merge resolved secrets into server config
    for key_ in required_secret_keys:
        if key_ in resolved_secrets:
            syncsk_server_config[key_] = resolved_secrets[key_]

    return syncsk_server_config