Skip to content

sync_settings

DefaultSyncInfo

Bases: BaseSettingsModel

As statuses already have names and short names we only need the short name to match Kitsu with Ayon

Source code in server/settings/sync_settings.py
80
81
82
83
84
85
86
87
88
class DefaultSyncInfo(BaseSettingsModel):
    """As statuses already have names and short names we only need the short name to match Kitsu with Ayon"""

    default_task_info: list[TaskCondition] = SettingsField(
        default_factory=list, title="Tasks"
    )
    default_status_info: list[StatusCondition] = SettingsField(
        default_factory=list, title="Statuses"
    )

RolesCondition

Bases: BaseSettingsModel

Set what Ayon role users should get based in their Kitsu role

Source code in server/settings/sync_settings.py
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class RolesCondition(BaseSettingsModel):
    """Set what Ayon role users should get based in their Kitsu role"""

    admin: str = SettingsField(
        "admin", enum_resolver=_roles_enum, title="Studio manager"
    )
    vendor: str = SettingsField(
        "user", enum_resolver=_roles_enum, title="Vendor"
    )
    client: str = SettingsField(
        "user", enum_resolver=_roles_enum, title="Client"
    )
    manager: str = SettingsField(
        "manager", enum_resolver=_roles_enum, title="Production manager"
    )
    supervisor: str = SettingsField(
        "manager", enum_resolver=_roles_enum, title="Supervisor"
    )
    user: str = SettingsField(
        "user", enum_resolver=_roles_enum, title="Artist"
    )

SyncSettings

Bases: BaseSettingsModel

Enabling 'Delete projects' will remove projects on Ayon when they get deleted on Kitsu

Source code in server/settings/sync_settings.py
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
class SyncSettings(BaseSettingsModel):
    """Enabling 'Delete projects' will remove projects on Ayon when they get deleted on Kitsu"""

    delete_projects: bool = SettingsField(title="Delete projects")
    sync_users: SyncUsers = SettingsField(
        default_factory=SyncUsers,
        title="Sync users",
    )
    default_sync_info: DefaultSyncInfo = SettingsField(
        default_factory=DefaultSyncInfo,
        title="Default sync info",
    )

SyncUsers

Bases: BaseSettingsModel

When a Kitsu user is synced, the default password will be set for the newly created user. Please ask the user to change the password inside Ayon.

Source code in server/settings/sync_settings.py
39
40
41
42
43
44
45
46
47
48
49
class SyncUsers(BaseSettingsModel):
    """When a Kitsu user is synced, the default password will be set for the newly created user.
    Please ask the user to change the password inside Ayon.
    """

    enabled: bool = SettingsField(True)
    default_password: str = SettingsField(title="Default Password")
    access_group: str = SettingsField(title="Access Group", regex=NAME_REGEX)
    roles: RolesCondition = SettingsField(
        default_factory=RolesCondition, title="Roles"
    )