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

{ayon-python-api-0.1.1 → ayon-python-api-0.1.3}/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.3
+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.
@@ -19,8 +19,11 @@ Description: # Ayon server API
         - Missing CRUD operations for entities (Only read is possible)
         - 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
+            - find more suitable names of classes
+            - find more suitable name of objects (right now is used `connection` or `conn`)
+        - Add folder and task changes to operations
+          - Entity hub should use operations to update folders and tasks 
+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.3}/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.
@@ -11,3 +11,7 @@ Client should support connection to server with raw REST functions and prepared
 - Missing CRUD operations for entities (Only read is possible)
 - 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`
+    - find more suitable names of classes
+    - find more suitable name of objects (right now is used `connection` or `conn`)
+- Add folder and task changes to operations
+  - Entity hub should use operations to update folders and tasks 

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

@@ -0,0 +1,113 @@
+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",
+    "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",
+
+    "create_thumbnail",
+    "get_thumbnail",
+    "get_folder_thumbnail",
+    "get_version_thumbnail",
+    "get_workfile_thumbnail",
+)

ayon-python-api-0.1.3/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",
+}