Ayon-Python-Api 0.1.10__tar.gz → 0.1.12__tar.gz

{ayon-python-api-0.1.10/ayon_python_api.egg-info → ayon-python-api-0.1.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ayon-python-api
-Version: 0.1.10
+Version: 0.1.12
 Summary: AYON Python API
 Home-page: https://github.com/ynput/ayon-python-api
 Author: ynput.io

{ayon-python-api-0.1.10 → ayon-python-api-0.1.12}/ayon_api/__init__.py

@@ -2,21 +2,32 @@ from .utils import (
     TransferProgress,
     slugify_string,
 )
-from .server import (
-    ServerAPIBase,
-)
-
 from .server_api import (
     ServerAPI,
+)
+
+from ._api import (
+    GlobalServerAPI,
     ServiceContext,
 
     init_service,
+    get_service_name,
+    get_service_addon_name,
+    get_service_addon_version,
+    get_service_addon_settings,
 
     is_connection_created,
+    create_connection,
     close_connection,
     change_token,
     set_environments,
     get_server_api_connection,
+    get_site_id,
+    set_site_id,
+    get_client_version,
+    set_client_version,
+    get_default_settings_variant,
+    set_default_settings_variant,
 
     get_base_url,
     get_rest_url,
@@ -54,12 +65,6 @@ from .server_api import (
     upload_dependency_package,
     delete_dependency_package,
 
-    get_full_production_settings,
-    get_production_settings,
-    get_full_project_settings,
-    get_project_settings,
-    get_addon_settings,
-
     get_user,
     get_users,
 
@@ -68,6 +73,18 @@ from .server_api import (
 
     get_project_anatomy_preset,
     get_project_anatomy_presets,
+    get_project_roots_by_site,
+    get_project_roots_for_site,
+
+    get_addon_site_settings_schema,
+    get_addon_settings_schema,
+
+    get_addon_studio_settings,
+    get_addon_project_settings,
+    get_addon_settings,
+    get_addons_studio_settings,
+    get_addons_project_settings,
+    get_addons_settings,
 
     get_projects,
     get_project,
@@ -115,17 +132,29 @@ __all__ = (
     "TransferProgress",
     "slugify_string",
 
-    "ServerAPIBase",
-
     "ServerAPI",
+
+    "GlobalServerAPI",
     "ServiceContext",
+
     "init_service",
+    "get_service_name",
+    "get_service_addon_name",
+    "get_service_addon_version",
+    "get_service_addon_settings",
 
     "is_connection_created",
+    "create_connection",
     "close_connection",
     "change_token",
     "set_environments",
     "get_server_api_connection",
+    "get_site_id",
+    "set_site_id",
+    "get_client_version",
+    "set_client_version",
+    "get_default_settings_variant",
+    "set_default_settings_variant",
 
     "get_base_url",
     "get_rest_url",
@@ -163,12 +192,6 @@ __all__ = (
     "upload_dependency_package",
     "delete_dependency_package",
 
-    "get_full_production_settings",
-    "get_production_settings",
-    "get_full_project_settings",
-    "get_project_settings",
-    "get_addon_settings",
-
     "get_user",
     "get_users",
 
@@ -177,6 +200,17 @@ __all__ = (
 
     "get_project_anatomy_preset",
     "get_project_anatomy_presets",
+    "get_project_roots_by_site",
+    "get_project_roots_for_site",
+
+    "get_addon_site_settings_schema",
+    "get_addon_settings_schema",
+    "get_addon_studio_settings",
+    "get_addon_project_settings",
+    "get_addon_settings",
+    "get_addons_studio_settings",
+    "get_addons_project_settings",
+    "get_addons_settings",
 
     "get_projects",
     "get_project",

ayon-python-api-0.1.10/ayon_api/server_api.py → ayon-python-api-0.1.12/ayon_api/_api.py

@@ -1,3 +1,11 @@
+"""Singleton based server api for direct access.
+
+This implementation will be probably the most used part of package. Gives
+option to have singleton connection to Server URL based on environment variable
+values. All public functions and classes are imported in '__init__.py' so
+they're available directly in top module import.
+"""
+
 import os
 import socket
 
@@ -5,11 +13,11 @@ from .constants import (
     SERVER_URL_ENV_KEY,
     SERVER_TOKEN_ENV_KEY,
 )
-from .server import ServerAPIBase
+from .server_api import ServerAPI
 from .exceptions import FailedServiceInit
 
 
-class ServerAPI(ServerAPIBase):
+class GlobalServerAPI(ServerAPI):
     """Extended server api which also handles storing tokens and url.
 
     Created object expect to have set environment variables
@@ -17,11 +25,11 @@ class ServerAPI(ServerAPIBase):
     but that can be filled afterwards with calling 'login' method.
     """
 
-    def __init__(self):
+    def __init__(self, site_id=None, client_version=None):
         url = self.get_url()
         token = self.get_token()
 
-        super(ServerAPI, self).__init__(url, token)
+        super(GlobalServerAPI, self).__init__(url, token, site_id, client_version)
 
         self.validate_server_availability()
         self.create_session()
@@ -34,7 +42,7 @@ class ServerAPI(ServerAPIBase):
         """
 
         previous_token = self._access_token
-        super(ServerAPI, self).login(username, password)
+        super(GlobalServerAPI, self).login(username, password)
         if self.has_valid_token and previous_token != self._access_token:
             os.environ[SERVER_TOKEN_ENV_KEY] = self._access_token
 
@@ -74,7 +82,7 @@ class GlobalContext:
 
     @classmethod
     def change_token(cls, url, token):
-        ServerAPI.set_environments(url, token)
+        GlobalServerAPI.set_environments(url, token)
         if cls._connection is None:
             return
 
@@ -89,10 +97,17 @@ class GlobalContext:
             cls._connection.close_session()
         cls._connection = None
 
+    @classmethod
+    def create_connection(cls, *args, **kwargs):
+        if cls._connection is not None:
+            cls.close_connection()
+        cls._connection = GlobalServerAPI(*args, **kwargs)
+        return cls._connection
+
     @classmethod
     def get_server_api_connection(cls):
         if cls._connection is None:
-            cls._connection = ServerAPI()
+            cls.create_connection()
         return cls._connection
 
 
@@ -170,8 +185,8 @@ class ServiceContext:
         cls.addon_version = addon_version
         cls.service_name = service_name or socket.gethostname()
 
-        # Make sure required environments for ServerAPI are set
-        ServerAPI.set_environments(cls.server_url, cls.token)
+        # Make sure required environments for GlobalServerAPI are set
+        GlobalServerAPI.set_environments(cls.server_url, cls.token)
 
         if connect:
             print("Connecting to server \"{}\"".format(server_url))
@@ -181,9 +196,74 @@ class ServiceContext:
 
 
 def init_service(*args, **kwargs):
+    """Initialize current connection from service.
+
+    The service expect specific environment variables. The variables must all
+    be set to make the connection work as a service.
+    """
+
     ServiceContext.init_service(*args, **kwargs)
 
 
+def get_service_addon_name():
+    """Name of addon which initialized service connection.
+
+    Service context must be initialized to be able to use this function. Call
+    'init_service' on you service start to do so.
+
+    Returns:
+        Union[str, None]: Name of addon or None.
+    """
+
+    return ServiceContext.addon_name
+
+
+def get_service_addon_version():
+    """Version of addon which initialized service connection.
+
+    Service context must be initialized to be able to use this function. Call
+    'init_service' on you service start to do so.
+
+    Returns:
+        Union[str, None]: Version of addon or None.
+    """
+
+    return ServiceContext.addon_version
+
+
+def get_service_name():
+    """Name of service.
+
+    Service context must be initialized to be able to use this function. Call
+    'init_service' on you service start to do so.
+
+    Returns:
+        Union[str, None]: Name of service if service was registered.
+    """
+
+    return ServiceContext.service_name
+
+
+def get_service_addon_settings():
+    """Addon settings of service which initialized service.
+
+    Service context must be initialized to be able to use this function. Call
+    'init_service' on you service start to do so.
+
+    Returns:
+        Dict[str, Any]: Addon settings.
+
+    Raises:
+        ValueError: When service was not initialized.
+    """
+
+    addon_name = get_service_addon_name()
+    addon_version = get_service_addon_version()
+    if addon_name is None or addon_version is None:
+        raise ValueError("Service is not initialized")
+    return get_addon_settings(addon_name, addon_version)
+
+
 def is_connection_created():
     """Is global connection created.
 
@@ -194,6 +274,20 @@ def is_connection_created():
     return GlobalContext.is_connection_created()
 
 
+def create_connection(site_id=None, client_version=None):
+    """Create global connection.
+
+    Args:
+        site_id (str): Machine site id/name.
+        client_version (str): Desktop app version.
+
+    Returns:
+        GlobalServerAPI: Created connection.
+    """
+
+    return GlobalContext.create_connection(site_id, client_version)
+
+
 def close_connection():
     """Close global connection if is connected."""
 
@@ -221,22 +315,92 @@ def set_environments(url, token):
         token (Union[str, None]): API key token to be used for connection.
     """
 
-    ServerAPI.set_environments(url, token)
+    GlobalServerAPI.set_environments(url, token)
 
 
 def get_server_api_connection():
-    """Access to global scope object of ServerAPI.
+    """Access to global scope object of GlobalServerAPI.
 
     This access expect to have set environment variables 'AYON_SERVER_URL'
     and 'AYON_TOKEN'.
 
     Returns:
-        ServerAPI: Object of connection to server.
+        GlobalServerAPI: Object of connection to server.
     """
 
     return GlobalContext.get_server_api_connection()
 
 
+def get_site_id():
+    con = get_server_api_connection()
+    return con.get_site_id()
+
+
+def set_site_id(site_id):
+    """Set site id of already connected client connection.
+
+    Site id is human-readable machine id used in AYON desktop application.
+
+    Args:
+        site_id (Union[str, None]): Site id used in connection.
+    """
+
+    con = get_server_api_connection()
+    con.set_site_id(site_id)
+
+
+def get_client_version():
+    """Version of client used to connect to server.
+
+    Client version is AYON client build desktop application.
+
+    Returns:
+        str: Client version string used in connection.
+    """
+
+    con = get_server_api_connection()
+    return con.get_client_version()
+
+
+def set_client_version(client_version):
+    """Set version of already connected client connection.
+
+    Client version is version of AYON desktop application.
+
+    Args:
+        client_version (Union[str, None]): Client version string.
+    """
+
+    con = get_server_api_connection()
+    con.set_client_version(client_version)
+
+
+def get_default_settings_variant():
+    """Default variant used for settings.
+
+    Returns:
+        Union[str, None]: name of variant or None.
+    """
+
+    con = get_server_api_connection()
+    return con.get_client_version()
+
+
+def set_default_settings_variant(variant):
+    """Change default variant for addon settings.
+
+    Note:
+        It is recommended to set only 'production' or 'staging' variants
+            as default variant.
+
+    Args:
+        variant (Union[str, None]): Settings variant name.
+    """
+
+    con = get_server_api_connection()
+    return con.set_default_settings_variant(variant)
+
+
 def get_base_url():
     con = get_server_api_connection()
     return con.get_base_url()
@@ -397,24 +561,34 @@ def get_project_anatomy_preset(*args, **kwargs):
     return con.get_project_anatomy_preset(*args, **kwargs)
 
 
-def get_full_production_settings(*args, **kwargs):
+def get_project_roots_by_site(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_project_roots(*args, **kwargs)
+
+
+def get_project_roots_for_site(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_project_roots_for_site(*args, **kwargs)
+
+
+def get_addon_settings_schema(*args, **kwargs):
     con = get_server_api_connection()
-    return con.get_full_production_settings(*args, **kwargs)
+    return con.get_addon_settings_schema(*args, **kwargs)
 
 
-def get_production_settings(*args, **kwargs):
+def get_addon_site_settings_schema(*args, **kwargs):
     con = get_server_api_connection()
-    return con.get_production_settings(*args, **kwargs)
+    return con.get_addon_site_settings_schema(*args, **kwargs)
 
 
-def get_full_project_settings(*args, **kwargs):
+def get_addon_studio_settings(*args, **kwargs):
     con = get_server_api_connection()
-    return con.get_full_project_settings(*args, **kwargs)
+    return con.get_addon_studio_settings(*args, **kwargs)
 
 
-def get_project_settings(*args, **kwargs):
+def get_addon_project_settings(*args, **kwargs):
     con = get_server_api_connection()
-    return con.get_project_settings(*args, **kwargs)
+    return con.get_addon_project_settings(*args, **kwargs)
 
 
 def get_addon_settings(*args, **kwargs):
@@ -422,6 +596,26 @@ def get_addon_settings(*args, **kwargs):
     return con.get_addon_settings(*args, **kwargs)
 
 
+def get_addon_site_settings(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_addon_site_settings(*args, **kwargs)
+
+
+def get_addons_studio_settings(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_addons_studio_settings(*args, **kwargs)
+
+
+def get_addons_project_settings(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_addons_project_settings(*args, **kwargs)
+
+
+def get_addons_settings(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_addons_settings(*args, **kwargs)
+
+
 def get_project(*args, **kwargs):
     con = get_server_api_connection()
     return con.get_project(*args, **kwargs)

{ayon-python-api-0.1.10 → ayon-python-api-0.1.12}/ayon_api/entity_hub.py

@@ -3,7 +3,7 @@ import collections
 from abc import ABCMeta, abstractmethod, abstractproperty
 
 import six
-from .server_api import get_server_api_connection
+from ._api import get_server_api_connection
 from .utils import create_entity_id, convert_entity_id
 
 UNKNOWN_VALUE = object()
@@ -27,7 +27,7 @@ class EntityHub(object):
 
     Args:
         project_name (str): Name of project where changes will happen.
-        connection (ServerAPIBase): Connection to server with logged user.
+        connection (ServerAPI): Connection to server with logged user.
         allow_data_changes (bool): This option gives ability to change 'data'
             key on entities. This is not recommended as 'data' may be use for
             secure information and would also slow down server queries. Content

ayon-python-api-0.1.12/ayon_api/events.py

@@ -0,0 +1,52 @@
+import copy
+
+
+class ServerEvent(object):
+    def __init__(
+        self,
+        topic,
+        sender=None,
+        event_hash=None,
+        project_name=None,
+        username=None,
+        dependencies=None,
+        description=None,
+        summary=None,
+        payload=None,
+        finished=True,
+        store=True,
+    ):
+        if dependencies is None:
+            dependencies = []
+        if payload is None:
+            payload = {}
+        if summary is None:
+            summary = {}
+
+        self.topic = topic
+        self.sender = sender
+        self.event_hash = event_hash
+        self.project_name = project_name
+        self.username = username
+        self.dependencies = dependencies
+        self.description = description
+        self.summary = summary
+        self.payload = payload
+        self.finished = finished
+        self.store = store
+
+    def to_data(self):
+        return {
+            "topic": self.topic,
+            "sender": self.sender,
+            "hash": self.event_hash,
+            "project": self.project_name,
+            "user": self.username,
+            "dependencies": copy.deepcopy(self.dependencies),
+            "description": self.description,
+            "description": self.description,
+            "summary": copy.deepcopy(self.summary),
+            "payload": self.payload,
+            "finished": self.finished,
+            "store": self.store
+        }

{ayon-python-api-0.1.10 → ayon-python-api-0.1.12}/ayon_api/operations.py

@@ -6,7 +6,7 @@ from abc import ABCMeta, abstractproperty
 
 import six
 
-from .server_api import get_server_api_connection
+from ._api import get_server_api_connection
 from .utils import create_entity_id, REMOVED_VALUE