ayon-python-api 1.0.8__tar.gz → 1.0.10__tar.gz

{ayon-python-api-1.0.8 → ayon-python-api-1.0.10}/PKG-INFO

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

{ayon-python-api-1.0.8 → ayon-python-api-1.0.10}/ayon_api/__init__.py

@@ -7,6 +7,8 @@ from .utils import (
     is_token_valid,
     validate_url,
     login_to_server,
+    take_web_action_event,
+    abort_web_action_event,
 )
 from .server_api import (
     RequestTypes,
@@ -85,6 +87,7 @@ from ._api import (
     get_attributes_fields_for_type,
     get_default_fields_for_type,
     get_addons_info,
+    get_addon_endpoint,
     get_addon_url,
     download_addon_private_file,
     get_installers,
@@ -103,6 +106,7 @@ from ._api import (
     get_bundles,
     create_bundle,
     update_bundle,
+    check_bundle_compatibility,
     delete_bundle,
     get_project_anatomy_presets,
     get_default_anatomy_preset_name,
@@ -238,6 +242,8 @@ __all__ = (
     "is_token_valid",
     "validate_url",
     "login_to_server",
+    "take_web_action_event",
+    "abort_web_action_event",
 
     "RequestTypes",
     "ServerAPI",
@@ -313,6 +319,7 @@ __all__ = (
     "get_attributes_fields_for_type",
     "get_default_fields_for_type",
     "get_addons_info",
+    "get_addon_endpoint",
     "get_addon_url",
     "download_addon_private_file",
     "get_installers",
@@ -331,6 +338,7 @@ __all__ = (
     "get_bundles",
     "create_bundle",
     "update_bundle",
+    "check_bundle_compatibility",
     "delete_bundle",
     "get_project_anatomy_presets",
     "get_default_anatomy_preset_name",

{ayon-python-api-1.0.8 → ayon-python-api-1.0.10}/ayon_api/_api.py

@@ -18,6 +18,9 @@ from .constants import (
 )
 from .server_api import ServerAPI
 from .exceptions import FailedServiceInit
+from .utils import (
+    get_default_settings_variant as _get_default_settings_variant
+)
 
 
 class GlobalServerAPI(ServerAPI):
@@ -502,6 +505,8 @@ def get_default_settings_variant():
         Union[str, None]: name of variant or None.
 
     """
+    if not GlobalContext.is_connection_created():
+        return _get_default_settings_variant()
     con = get_server_api_connection()
     return con.get_default_settings_variant()
 
@@ -722,6 +727,7 @@ def get_events(*args, **kwargs):
 
     Args:
         topics (Optional[Iterable[str]]): Name of topics.
+        event_ids (Optional[Iterable[str]]): Event ids.
         project_names (Optional[Iterable[str]]): Project on which
             event happened.
         states (Optional[Iterable[str]]): Filtering by states.
@@ -746,6 +752,22 @@ def get_events(*args, **kwargs):
 
 
 def update_event(*args, **kwargs):
+    """Update event data.
+
+    Args:
+        event_id (str): Event id.
+        sender (Optional[str]): New sender of event.
+        project_name (Optional[str]): New project name.
+        username (Optional[str]): New username.
+        status (Optional[str]): New event status. Enum: "pending",
+            "in_progress", "finished", "failed", "aborted", "restarted"
+        description (Optional[str]): New description.
+        summary (Optional[dict[str, Any]]): New summary.
+        payload (Optional[dict[str, Any]]): New payload.
+        progress (Optional[int]): New progress. Range [0-100].
+        retries (Optional[int]): New retries.
+
+    """
     con = get_server_api_connection()
     return con.update_event(*args, **kwargs)
 
@@ -758,17 +780,19 @@ def dispatch_event(*args, **kwargs):
         sender (Optional[str]): Sender of event.
         event_hash (Optional[str]): Event hash.
         project_name (Optional[str]): Project name.
+        depends_on (Optional[str]): Add dependency to another event.
         username (Optional[str]): Username which triggered event.
-        dependencies (Optional[list[str]]): List of event id dependencies.
         description (Optional[str]): Description of event.
-        summary (Optional[dict[str, Any]]): Summary of event that can be used
-            for simple filtering on listeners.
+        summary (Optional[dict[str, Any]]): Summary of event that can
+            be used for simple filtering on listeners.
         payload (Optional[dict[str, Any]]): Full payload of event data with
             all details.
         finished (Optional[bool]): Mark event as finished on dispatch.
         store (Optional[bool]): Store event in event queue for possible
             future processing otherwise is event send only
             to active listeners.
+        dependencies (Optional[list[str]]): Deprecated.
+            List of event id dependencies.
 
     Returns:
         RestApiResponse: Response from server.
@@ -851,7 +875,8 @@ def download_file_to_stream(*args, **kwargs):
 
     Args:
         endpoint (str): Endpoint or URL to file that should be downloaded.
-        stream (Union[io.BytesIO, BinaryIO]): Stream where output will be stored.
+        stream (Union[io.BytesIO, BinaryIO]): Stream where output will
+            be stored.
         chunk_size (Optional[int]): Size of chunks that are received
             in single loop.
         progress (Optional[TransferProgress]): Object that gives ability
@@ -1131,6 +1156,30 @@ def get_addons_info(*args, **kwargs):
     return con.get_addons_info(*args, **kwargs)
 
 
+def get_addon_endpoint(*args, **kwargs):
+    """Calculate endpoint to addon route.
+
+    Examples:
+
+        >>> api = ServerAPI("https://your.url.com")
+        >>> api.get_addon_url(
+        ...     "example", "1.0.0", "private", "my.zip")
+        'addons/example/1.0.0/private/my.zip'
+
+    Args:
+        addon_name (str): Name of addon.
+        addon_version (str): Version of addon.
+        *subpaths (str): Any amount of subpaths that are added to
+            addon url.
+
+    Returns:
+        str: Final url.
+
+    """
+    con = get_server_api_connection()
+    return con.get_addon_endpoint(*args, **kwargs)
+
+
 def get_addon_url(*args, **kwargs):
     """Calculate url to addon route.
 
@@ -1139,13 +1188,14 @@ def get_addon_url(*args, **kwargs):
         >>> api = ServerAPI("https://your.url.com")
         >>> api.get_addon_url(
         ...     "example", "1.0.0", "private", "my.zip")
-        'https://your.url.com/addons/example/1.0.0/private/my.zip'
+        'https://your.url.com/api/addons/example/1.0.0/private/my.zip'
 
     Args:
         addon_name (str): Name of addon.
         addon_version (str): Version of addon.
         *subpaths (str): Any amount of subpaths that are added to
             addon url.
+        use_rest (Optional[bool]): Use rest endpoint.
 
     Returns:
         str: Final url.
@@ -1480,7 +1530,23 @@ def create_bundle(*args, **kwargs):
     """Create bundle on server.
 
     Bundle cannot be changed once is created. Only isProduction, isStaging
-    and dependency packages can change after creation.
+    and dependency packages can change after creation. In case dev bundle
+    is created, it is possible to change anything, but it is not possible
+    to mark bundle as dev and production or staging at the same time.
+
+    Development addon config can define custom path to client code. It is
+    used only for dev bundles.
+
+    Example of 'dev_addons_config'::
+
+        ```json
+        {
+            "core": {
+                "enabled": true,
+                "path": "/path/to/ayon-core/client"
+            }
+        }
+        ```
 
     Args:
         name (str): Name of bundle.
@@ -1492,6 +1558,11 @@ def create_bundle(*args, **kwargs):
         is_production (Optional[bool]): Bundle will be marked as
             production.
         is_staging (Optional[bool]): Bundle will be marked as staging.
+        is_dev (Optional[bool]): Bundle will be marked as dev.
+        dev_active_user (Optional[str]): Username that will be assigned
+            to dev bundle. Can be used only if 'is_dev' is set to 'True'.
+        dev_addons_config (Optional[dict[str, Any]]): Configuration for
+            dev addons. Can be used only if 'is_dev' is set to 'True'.
 
     """
     con = get_server_api_connection()
@@ -1507,17 +1578,55 @@ def update_bundle(*args, **kwargs):
 
     Args:
         bundle_name (str): Name of bundle.
+        addon_versions (Optional[dict[str, str]]): Addon versions,
+            possible only for dev bundles.
+        installer_version (Optional[str]): Installer version, possible
+            only for dev bundles.
         dependency_packages (Optional[dict[str, str]]): Dependency pacakge
             names that should be used with the bundle.
         is_production (Optional[bool]): Bundle will be marked as
             production.
         is_staging (Optional[bool]): Bundle will be marked as staging.
+        is_dev (Optional[bool]): Bundle will be marked as dev.
+        dev_active_user (Optional[str]): Username that will be assigned
+            to dev bundle. Can be used only for dev bundles.
+        dev_addons_config (Optional[dict[str, Any]]): Configuration for
+            dev addons. Can be used only for dev bundles.
 
     """
     con = get_server_api_connection()
     return con.update_bundle(*args, **kwargs)
 
 
+def check_bundle_compatibility(*args, **kwargs):
+    """Check bundle compatibility.
+
+    Can be used as per-flight validation before creating bundle.
+
+    Args:
+        name (str): Name of bundle.
+        addon_versions (dict[str, str]): Addon versions.
+        installer_version (Union[str, None]): Installer version.
+        dependency_packages (Optional[dict[str, str]]): Dependency
+            package names. Keys are platform names and values are name of
+            packages.
+        is_production (Optional[bool]): Bundle will be marked as
+            production.
+        is_staging (Optional[bool]): Bundle will be marked as staging.
+        is_dev (Optional[bool]): Bundle will be marked as dev.
+        dev_active_user (Optional[str]): Username that will be assigned
+            to dev bundle. Can be used only if 'is_dev' is set to 'True'.
+        dev_addons_config (Optional[dict[str, Any]]): Configuration for
+            dev addons. Can be used only if 'is_dev' is set to 'True'.
+
+    Returns:
+        Dict[str, Any]: Server response, with 'success' and 'issues'.
+
+    """
+    con = get_server_api_connection()
+    return con.check_bundle_compatibility(*args, **kwargs)
+
+
 def delete_bundle(*args, **kwargs):
     """Delete bundle from server.
 
@@ -2343,8 +2452,8 @@ def get_folders(*args, **kwargs):
     """Query folders from server.
 
     Todos:
-        Folder name won't be unique identifier, so we should add folder path
-            filtering.
+        Folder name won't be unique identifier, so we should add
+            folder path filtering.
 
     Notes:
         Filter 'active' don't have direct filter in GraphQl.
@@ -2370,6 +2479,8 @@ def get_folders(*args, **kwargs):
             children. Ignored when None, default behavior.
         statuses (Optional[Iterable[str]]): Folder statuses used
             for filtering.
+        assignees_all (Optional[Iterable[str]]): Filter by assigness
+            on children tasks. Task must have all of passed assignees.
         tags (Optional[Iterable[str]]): Folder tags used
             for filtering.
         active (Optional[bool]): Filter active/inactive folders.
@@ -2992,10 +3103,12 @@ def get_versions(*args, **kwargs):
             version filtering.
         product_ids (Optional[Iterable[str]]): Product ids used for
             version filtering.
+        task_ids (Optional[Iterable[str]]): Task ids used for
+            version filtering.
         versions (Optional[Iterable[int]]): Versions we're interested in.
-        hero (Optional[bool]): Receive also hero versions when set to true.
-        standard (Optional[bool]): Receive versions which are not hero when
-            set to true.
+        hero (Optional[bool]): Skip hero versions when set to False.
+        standard (Optional[bool]): Skip standard (non-hero) when
+            set to False.
         latest (Optional[bool]): Return only latest version of standard
             versions. This can be combined only with 'standard' attribute
             set to True.
@@ -3250,6 +3363,7 @@ def update_version(*args, **kwargs):
         version (Optional[int]): New version.
         product_id (Optional[str]): New product id.
         task_id (Optional[Union[str, None]]): New task id.
+        author (Optional[str]): New author username.
         attrib (Optional[dict[str, Any]]): New attributes.
         data (Optional[dict[str, Any]]): New data.
         tags (Optional[Iterable[str]]): New tags.
@@ -3277,9 +3391,10 @@ def delete_version(*args, **kwargs):
 def get_representations(*args, **kwargs):
     """Get representation entities based on passed filters from server.
 
-    Todos:
+    .. todo::
+
         Add separated function for 'names_by_version_ids' filtering.
-            Because can't be combined with others.
+        Because can't be combined with others.
 
     Args:
         project_name (str): Name of project where to look for versions.
@@ -3289,7 +3404,7 @@ def get_representations(*args, **kwargs):
             names used for representation filtering.
         version_ids (Optional[Iterable[str]]): Version ids used for
             representation filtering. Versions are parents of
-                representations.
+            representations.
         names_by_version_ids (Optional[bool]): Find representations
             by names and version ids. This filter discard all
             other filters.
@@ -4028,7 +4143,10 @@ def delete_link(*args, **kwargs):
 def get_entities_links(*args, **kwargs):
     """Helper method to get links from server for entity types.
 
-    Example output::
+    .. highlight:: text
+    .. code-block:: text
+
+        Example output:
         {
             "59a212c0d2e211eda0e20242ac120001": [
                 {
@@ -4049,12 +4167,12 @@ def get_entities_links(*args, **kwargs):
     Args:
         project_name (str): Project where links are.
         entity_type (Literal["folder", "task", "product",
-            "version", "representations"]): Entity type.
+        |    "version", "representations"]): Entity type.
         entity_ids (Optional[Iterable[str]]): Ids of entities for which
-            links should be received.
+        |    links should be received.
         link_types (Optional[Iterable[str]]): Link type filters.
         link_direction (Optional[Literal["in", "out"]]): Link direction
-            filter.
+        |    filter.
         link_names (Optional[Iterable[str]]): Link name filters.
         link_name_regex (Optional[str]): Regex filter for link name.