Ayon-Python-Api 0.1.1__tar.gz → 0.1.2__tar.gz

{ayon-python-api-0.1.1 → ayon-python-api-0.1.2}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: ayon-python-api
-Version: 0.1.1
-Summary: Ayon Python API
+Version: 0.1.2
+Summary: AYON Python API
 Home-page: https://github.com/ynput/ayon-python-api
 Author: ynput.io
 Author-email: info@ynput.io
-License: UNKNOWN
-Description: # Ayon server API
+License: Apache License (2.0)
+Description: # AYON server API
         Python client for connection server. Client must be (at least for some time) Python 2 compatible because will be used in DCC that are "older".
         
         Client should support connection to server with raw REST functions and prepared functionality for work with entities. Must not contain only functionality that can be used with core server functionality.
@@ -20,7 +20,7 @@ Description: # Ayon server API
         - More clear what is difference in `ServerAPIBase` and `ServerAPI`
             - `ServerAPI` was added primarily for desktop app which handle login and logout in a different way so the class should be maybe removed and `ServerAPIBase` should be renamed to `ServerAPI`
         
-Keywords: ayon,ynput,OpenPype,vfx
+Keywords: AYON,ynput,OpenPype,vfx
 Platform: UNKNOWN
 Classifier: Development Status :: 3 - Alpha
 Classifier: Programming Language :: Python

{ayon-python-api-0.1.1 → ayon-python-api-0.1.2}/README.md

@@ -1,4 +1,4 @@
-# Ayon server API
+# AYON server API
 Python client for connection server. Client must be (at least for some time) Python 2 compatible because will be used in DCC that are "older".
 
 Client should support connection to server with raw REST functions and prepared functionality for work with entities. Must not contain only functionality that can be used with core server functionality.

ayon-python-api-0.1.2/ayon_api/__init__.py

@@ -0,0 +1,106 @@
+from .server import (
+    ServerAPIBase,
+)
+
+from .server_api import (
+    ServerAPI,
+
+    get_server_api_connection,
+
+    get,
+    post,
+    put,
+    patch,
+    delete,
+
+    get_projects,
+    get_project,
+    create_project,
+    delete_project,
+
+    get_folder_by_id,
+    get_folder_by_name,
+    get_folder_by_path,
+    get_folders,
+
+    get_tasks,
+
+    get_folder_ids_with_subsets,
+    get_subset_by_id,
+    get_subset_by_name,
+    get_subsets,
+    get_subset_families,
+
+    get_version_by_id,
+    get_version_by_name,
+    version_is_latest,
+    get_versions,
+    get_hero_version_by_subset_id,
+    get_hero_version_by_id,
+    get_hero_versions,
+    get_last_versions,
+    get_last_version_by_subset_id,
+    get_last_version_by_subset_name,
+    get_representation_by_id,
+    get_representation_by_name,
+    get_representations,
+    get_representations_parents,
+    get_representation_parents,
+
+    get_project_settings,
+    get_addon_settings,
+
+    create_thumbnail,
+    get_thumbnail,
+    get_folder_thumbnail,
+    get_version_thumbnail,
+    get_workfile_thumbnail,
+)
+
+
+__all__ = (
+    "ServerAPIBase",
+
+    "ServerAPI",
+    "get_server_api_connection",
+    "get",
+    "post",
+    "put",
+    "patch",
+    "delete",
+
+    "get_project_settings",
+    "get_addon_settings",
+
+    "get_projects",
+    "get_project",
+
+    "get_folder_by_id",
+    "get_folder_by_name",
+    "get_folder_by_path",
+    "get_folders",
+
+    "get_tasks",
+
+    "get_folder_ids_with_subsets",
+    "get_subset_by_id",
+    "get_subset_by_name",
+    "get_subsets",
+    "get_subset_families",
+    "get_version_by_id",
+    "get_version_by_name",
+    "version_is_latest",
+    "get_versions",
+    "get_hero_version_by_subset_id",
+    "get_hero_version_by_id",
+    "get_hero_versions",
+    "get_last_versions",
+    "get_last_version_by_subset_id",
+    "get_last_version_by_subset_name",
+    "get_representation_by_id",
+    "get_representation_by_name",
+    "get_representations",
+    "get_representations_parents",
+    "get_representation_parents",
+    "get_thumbnail_id_from_source",
+)

ayon-python-api-0.1.2/ayon_api/constants.py

@@ -0,0 +1,90 @@
+SERVER_URL_ENV_KEY = "AYON_SERVER_URL"
+SERVER_TOKEN_ENV_KEY = "AYON_TOKEN"
+
+# --- Project ---
+DEFAULT_PROJECT_FIELDS = {
+    "active",
+    "name",
+    "code",
+    "config",
+    "createdAt",
+}
+
+# --- Folders ---
+DEFAULT_FOLDER_FIELDS = {
+    "id",
+    "name",
+    "label",
+    "folderType",
+    "path",
+    "parentId",
+    "active",
+    "thumbnailId",
+}
+
+# --- Tasks ---
+DEFAULT_TASK_FIELDS = {
+    "id",
+    "name",
+    "label",
+    "taskType",
+    "folderId",
+    "active",
+    "assignees",
+}
+
+# --- Subsets ---
+DEFAULT_SUBSET_FIELDS = {
+    "id",
+    "name",
+    "folderId",
+    "active",
+    "family",
+}
+
+# --- Versions ---
+DEFAULT_VERSION_FIELDS = {
+    "id",
+    "name",
+    "version",
+    "subsetId",
+    "taskId",
+    "active",
+    "author",
+    "thumbnailId",
+    "createdAt",
+    "updatedAt",
+}
+
+# --- Representations ---
+DEFAULT_REPRESENTATION_FIELDS = {
+    "id",
+    "name",
+    "context",
+    "createdAt",
+    "active",
+    "versionId",
+}
+
+REPRESENTATION_FILES_FIELDS = {
+    "files.baseName",
+    "files.hash",
+    "files.id",
+    "files.path",
+    "files.size",
+}
+
+# --- Workfile info ---
+DEFAULT_WORKFILE_INFO_FIELDS = {
+    "active",
+    "createdAt",
+    "createdBy",
+    "id",
+    "name",
+    "path",
+    "projectName",
+    "taskId",
+    "thumbnailId",
+    "updatedAt",
+    "updatedBy",
+}

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

@@ -0,0 +1,105 @@
+import copy
+
+from .server import get_server_api_connection
+
+
+class ServerEvent(object):
+    def __init__(
+        self,
+        topic,
+        sender=None,
+        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.hash = hash
+        self.project_name = project_name
+        self.username = username
+        self.dependencies = dependencies
+        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.hash,
+            "project": self.project_name,
+            "user": self.username,
+            "dependencies": copy.deepcopy(self.dependencies),
+            "description": self.description,
+            "summary": copy.deepcopy(self.summary),
+            "payload": self.payload,
+            "finished": self.finished,
+            "store": self.store
+        }
+
+
+def dispatch_event(
+    topic,
+    sender=None,
+    hash=None,
+    project_name=None,
+    username=None,
+    dependencies=None,
+    description=None,
+    summary=None,
+    payload=None,
+    finished=True,
+    store=True,
+):
+    """Dispatch event to server.
+
+    Arg:
+        topic (str): Event topic used for filtering of listeners.
+        sender (Optional[str]): Sender of event.
+        hash (Optional[str]): Event hash.
+        project_name (Optional[str]): Project name.
+        username (Optional[str]): Username which triggered event.
+        dependencies (Optional[list[str]]): List of event id deprendencies.
+        description (Optional[str]): Description of event.
+        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 (bool): Mark event as finished on dispatch.
+        store (bool): Store event in event queue for possible future processing
+            otherwise is event send only to active listeners.
+    """
+
+    event = ServerEvent(
+        topic,
+        sender,
+        hash,
+        project_name,
+        username,
+        dependencies,
+        description,
+        summary,
+        payload,
+        finished,
+        store
+    )
+    con = get_server_api_connection()
+    response = con.post("events", json=event.to_data())
+    if response:
+        print(response, response.data)
+        return event
+    return None

ayon-python-api-0.1.2/ayon_api/exceptions.py

@@ -0,0 +1,2 @@
+class FailedOperations(Exception):
+    pass