Ayon-Python-Api 0.1.16__tar.gz → 0.1.18__tar.gz

{ayon-python-api-0.1.16 → ayon-python-api-0.1.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ayon-python-api
-Version: 0.1.16
+Version: 0.1.18
 Summary: AYON Python API
 Home-page: https://github.com/ynput/ayon-python-api
 Author: ynput.io
@@ -19,7 +19,7 @@ Python client for connection server. Client must be (at least for some time) Pyt
 
 AYON Python api 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.
 
-Module support singleton connection which is using `AYON_SERVER_URL` and `AYON_TOKEN` environment variables as source for connection. The singleton connection is using `ServerAPI` object. There can be created multiple connection to different server at one time, for that purpose use `ServerAPIBase` object.
+Module support singleton connection which is using `AYON_SERVER_URL` and `AYON_API_KEY` environment variables as source for connection. The singleton connection is using `ServerAPI` object. There can be created multiple connection to different server at one time, for that purpose use `ServerAPIBase` object.
 
 ## Install
 AYON python api is available on PyPi:
@@ -65,8 +65,16 @@ If pip complain that `ayon-python-api` is already installed just uninstall exist
 - Add all available CRUD operation on entities using REST
 - Add folder and task changes to operations
 - Enhance entity hub
+  - Missing docstrings in EntityHub -> especially entity arguments are missing
+  - Better order of arguments for entity classes
+    - Move entity hub to first place
+    - Skip those which are invalid for the entity and fake it for base or remove it from base
   - Entity hub should use operations session to do changes
   - Entity hub could also handle 'subset', 'version' and 'representation' entities
-  - Missing docstrings in EntityHub -> especially entity arguments are missing
-- Pass docstrings and arguments definitions from `ServerAPI` methods to global functions
+  - Missing 'statuses' on project
+  - Missing 'status' on folders
+  - Missing assignees on tasks
+  - Pass docstrings and arguments definitions from `ServerAPI` methods to global functions
+- Split `ServerAPI` into smaller chunks (somehow), the class has 4k+ lines of code
+- Add .pyi stub for ServerAPI 
 - Missing websockets connection

{ayon-python-api-0.1.16 → ayon-python-api-0.1.18}/README.md

@@ -3,7 +3,7 @@ Python client for connection server. Client must be (at least for some time) Pyt
 
 AYON Python api 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.
 
-Module support singleton connection which is using `AYON_SERVER_URL` and `AYON_TOKEN` environment variables as source for connection. The singleton connection is using `ServerAPI` object. There can be created multiple connection to different server at one time, for that purpose use `ServerAPIBase` object.
+Module support singleton connection which is using `AYON_SERVER_URL` and `AYON_API_KEY` environment variables as source for connection. The singleton connection is using `ServerAPI` object. There can be created multiple connection to different server at one time, for that purpose use `ServerAPIBase` object.
 
 ## Install
 AYON python api is available on PyPi:
@@ -49,8 +49,16 @@ If pip complain that `ayon-python-api` is already installed just uninstall exist
 - Add all available CRUD operation on entities using REST
 - Add folder and task changes to operations
 - Enhance entity hub
+  - Missing docstrings in EntityHub -> especially entity arguments are missing
+  - Better order of arguments for entity classes
+    - Move entity hub to first place
+    - Skip those which are invalid for the entity and fake it for base or remove it from base
   - Entity hub should use operations session to do changes
   - Entity hub could also handle 'subset', 'version' and 'representation' entities
-  - Missing docstrings in EntityHub -> especially entity arguments are missing
-- Pass docstrings and arguments definitions from `ServerAPI` methods to global functions
+  - Missing 'statuses' on project
+  - Missing 'status' on folders
+  - Missing assignees on tasks
+  - Pass docstrings and arguments definitions from `ServerAPI` methods to global functions
+- Split `ServerAPI` into smaller chunks (somehow), the class has 4k+ lines of code
+- Add .pyi stub for ServerAPI 
 - Missing websockets connection

{ayon-python-api-0.1.16 → ayon-python-api-0.1.18}/ayon_api/__init__.py

@@ -56,6 +56,7 @@ from ._api import (
     query_graphql,
 
     get_addons_info,
+    get_addon_url,
     download_addon_private_file,
 
     get_dependencies_info,
@@ -121,11 +122,35 @@ from ._api import (
     get_representation_parents,
     get_repre_ids_by_context_filters,
 
-    create_thumbnail,
     get_thumbnail,
     get_folder_thumbnail,
     get_version_thumbnail,
     get_workfile_thumbnail,
+    create_thumbnail,
+    update_thumbnail,
+
+    get_full_link_type_name,
+    get_link_types,
+    get_link_type,
+    create_link_type,
+    delete_link_type,
+    make_sure_link_type_exists,
+
+    create_link,
+    delete_link,
+    get_entities_links,
+    get_folder_links,
+    get_folders_links,
+    get_task_links,
+    get_tasks_links,
+    get_subset_links,
+    get_subsets_links,
+    get_version_links,
+    get_versions_links,
+    get_representations_links,
+    get_representation_links,
+
+    send_batch_operations,
 )
 
 
@@ -184,6 +209,7 @@ __all__ = (
     "query_graphql",
 
     "get_addons_info",
+    "get_addon_url",
     "download_addon_private_file",
 
     "get_dependencies_info",
@@ -248,9 +274,33 @@ __all__ = (
     "get_representation_parents",
     "get_repre_ids_by_context_filters",
 
-    "create_thumbnail",
     "get_thumbnail",
     "get_folder_thumbnail",
     "get_version_thumbnail",
     "get_workfile_thumbnail",
+    "create_thumbnail",
+    "update_thumbnail",
+
+    "get_full_link_type_name",
+    "get_link_types",
+    "get_link_type",
+    "create_link_type",
+    "delete_link_type",
+    "make_sure_link_type_exists",
+
+    "create_link",
+    "delete_link",
+    "get_entities_links",
+    "get_folder_links",
+    "get_folders_links",
+    "get_task_links",
+    "get_tasks_links",
+    "get_subset_links",
+    "get_subsets_links",
+    "get_version_links",
+    "get_versions_links",
+    "get_representations_links",
+    "get_representation_links",
+
+    "send_batch_operations",
 )

{ayon-python-api-0.1.16 → ayon-python-api-0.1.18}/ayon_api/_api.py

@@ -11,7 +11,7 @@ import socket
 
 from .constants import (
     SERVER_URL_ENV_KEY,
-    SERVER_TOKEN_ENV_KEY,
+    SERVER_API_ENV_KEY,
 )
 from .server_api import ServerAPI
 from .exceptions import FailedServiceInit
@@ -21,7 +21,7 @@ class GlobalServerAPI(ServerAPI):
     """Extended server api which also handles storing tokens and url.
 
     Created object expect to have set environment variables
-    'AYON_SERVER_URL'. Also is expecting filled 'AYON_TOKEN'
+    'AYON_SERVER_URL'. Also is expecting filled 'AYON_API_KEY'
     but that can be filled afterwards with calling 'login' method.
     """
 
@@ -44,7 +44,7 @@ class GlobalServerAPI(ServerAPI):
         previous_token = self._access_token
         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
+            os.environ[SERVER_API_ENV_KEY] = self._access_token
 
     @staticmethod
     def get_url():
@@ -52,7 +52,7 @@ class GlobalServerAPI(ServerAPI):
 
     @staticmethod
     def get_token():
-        return os.environ.get(SERVER_TOKEN_ENV_KEY)
+        return os.environ.get(SERVER_API_ENV_KEY)
 
     @staticmethod
     def set_environments(url, token):
@@ -64,7 +64,7 @@ class GlobalServerAPI(ServerAPI):
         """
 
         os.environ[SERVER_URL_ENV_KEY] = url or ""
-        os.environ[SERVER_TOKEN_ENV_KEY] = token or ""
+        os.environ[SERVER_API_ENV_KEY] = token or ""
 
 
 class GlobalContext:
@@ -151,7 +151,7 @@ class ServiceContext:
         connect=True
     ):
         token = cls.get_value_from_envs(
-            ("AY_API_KEY", "AYON_TOKEN"),
+            ("AY_API_KEY", "AYON_API_KEY"),
             token
         )
         server_url = cls.get_value_from_envs(
@@ -322,7 +322,7 @@ def get_server_api_connection():
     """Access to global scope object of GlobalServerAPI.
 
     This access expect to have set environment variables 'AYON_SERVER_URL'
-    and 'AYON_TOKEN'.
+    and 'AYON_API_KEY'.
 
     Returns:
         GlobalServerAPI: Object of connection to server.
@@ -521,6 +521,11 @@ def get_addons_info(*args, **kwargs):
     return con.get_addons_info(*args, **kwargs)
 
 
+def get_addon_url(addon_name, addon_version, *subpaths):
+    con = get_server_api_connection()
+    return con.get_addon_url(addon_name, addon_version, *subpaths)
+
+
 def download_addon_private_file(*args, **kwargs):
     con = get_server_api_connection()
     return con.download_addon_private_file(*args, **kwargs)
@@ -776,11 +781,6 @@ def delete_project(project_name):
     return con.delete_project(project_name)
 
 
-def create_thumbnail(project_name, src_filepath):
-    con = get_server_api_connection()
-    return con.create_thumbnail(project_name, src_filepath)
-
-
 def get_thumbnail(project_name, entity_type, entity_id, thumbnail_id=None):
     con = get_server_api_connection()
     con.get_thumbnail(project_name, entity_type, entity_id, thumbnail_id)
@@ -801,11 +801,259 @@ def get_workfile_thumbnail(project_name, workfile_id, thumbnail_id=None):
     return con.get_workfile_thumbnail(project_name, workfile_id, thumbnail_id)
 
 
-def create_thumbnail(project_name, src_filepath):
+def create_thumbnail(project_name, src_filepath, thumbnail_id=None):
+    con = get_server_api_connection()
+    return con.create_thumbnail(project_name, src_filepath, thumbnail_id)
+
+
+def update_thumbnail(project_name, thumbnail_id, src_filepath):
     con = get_server_api_connection()
-    return con.create_thumbnail(project_name, src_filepath)
+    return con.update_thumbnail(project_name, thumbnail_id, src_filepath)
 
 
 def get_default_fields_for_type(entity_type):
     con = get_server_api_connection()
     return con.get_default_fields_for_type(entity_type)
+
+
+def get_full_link_type_name(link_type_name, input_type, output_type):
+    con = get_server_api_connection()
+    return con.get_full_link_type_name(
+        link_type_name, input_type, output_type)
+
+
+def get_link_types(project_name):
+    con = get_server_api_connection()
+    return con.get_link_types(project_name)
+
+
+def get_link_type(project_name, link_type_name, input_type, output_type):
+    con = get_server_api_connection()
+    return con.get_link_type(
+        project_name, link_type_name, input_type, output_type)
+
+
+def create_link_type(
+    project_name, link_type_name, input_type, output_type, data=None):
+    con = get_server_api_connection()
+    return con.create_link_type(
+        project_name, link_type_name, input_type, output_type, data=data)
+
+
+def delete_link_type(project_name, link_type_name, input_type, output_type):
+    con = get_server_api_connection()
+    return con.delete_link_type(
+        project_name, link_type_name, input_type, output_type)
+
+
+def make_sure_link_type_exists(
+    project_name, link_type_name, input_type, output_type, data=None
+):
+    con = get_server_api_connection()
+    return con.make_sure_link_type_exists(
+        project_name, link_type_name, input_type, output_type, data=data
+    )
+
+
+def create_link(
+    project_name,
+    link_type_name,
+    input_id,
+    input_type,
+    output_id,
+    output_type
+):
+    con = get_server_api_connection()
+    return con.create_link(
+        project_name,
+        link_type_name,
+        input_id, input_type,
+        output_id, output_type
+    )
+
+
+def delete_link(project_name, link_id):
+    con = get_server_api_connection()
+    return con.delete_link(project_name, link_id)
+
+
+def get_entities_links(
+    project_name,
+    entity_type,
+    entity_ids=None,
+    link_types=None,
+    link_direction=None
+):
+    con = get_server_api_connection()
+    return con.get_entities_links(
+        project_name,
+        entity_type,
+        entity_ids,
+        link_types,
+        link_direction
+    )
+
+
+def get_folders_links(
+    project_name,
+    folder_ids=None,
+    link_types=None,
+    link_direction=None
+):
+    con = get_server_api_connection()
+    return con.get_folders_links(
+        project_name,
+        folder_ids,
+        link_types,
+        link_direction
+    )
+
+
+def get_folder_links(
+    project_name,
+    folder_id,
+    link_types=None,
+    link_direction=None
+):
+    con = get_server_api_connection()
+    return con.get_folder_links(
+        project_name,
+        folder_id,
+        link_types,
+        link_direction
+    )
+
+
+def get_tasks_links(
+    project_name,
+    task_ids=None,
+    link_types=None,
+    link_direction=None
+):
+    con = get_server_api_connection()
+    return con.get_tasks_links(
+        project_name,
+        task_ids,
+        link_types,
+        link_direction
+    )
+
+
+def get_task_links(
+    project_name,
+    task_id,
+    link_types=None,
+    link_direction=None
+):
+    con = get_server_api_connection()
+    return con.get_task_links(
+        project_name,
+        task_id,
+        link_types,
+        link_direction
+    )
+
+
+def get_subsets_links(
+    project_name,
+    subset_ids=None,
+    link_types=None,
+    link_direction=None
+):
+    con = get_server_api_connection()
+    return con.get_subsets_links(
+        project_name,
+        subset_ids,
+        link_types,
+        link_direction
+    )
+
+
+def get_subset_links(
+    project_name,
+    subset_id,
+    link_types=None,
+    link_direction=None
+):
+    con = get_server_api_connection()
+    return con.get_subset_links(
+        project_name,
+        subset_id,
+        link_types,
+        link_direction
+    )
+
+
+def get_versions_links(
+    project_name,
+    version_ids=None,
+    link_types=None,
+    link_direction=None
+):
+    con = get_server_api_connection()
+    return con.get_versions_links(
+        project_name,
+        version_ids,
+        link_types,
+        link_direction
+    )
+
+
+def get_version_links(
+    project_name,
+    version_id,
+    link_types=None,
+    link_direction=None
+):
+    con = get_server_api_connection()
+    return con.get_version_links(
+        project_name,
+        version_id,
+        link_types,
+        link_direction
+    )
+
+
+def get_representations_links(
+    project_name,
+    representation_ids=None,
+    link_types=None,
+    link_direction=None
+):
+    con = get_server_api_connection()
+    return con.get_representations_links(
+        project_name,
+        representation_ids,
+        link_types,
+        link_direction
+    )
+
+
+def get_representation_links(
+    project_name,
+    representation_id,
+    link_types=None,
+    link_direction=None
+):
+    con = get_server_api_connection()
+    return con.get_representation_links(
+        project_name,
+        representation_id,
+        link_types,
+        link_direction
+    )
+
+
+def send_batch_operations(
+    project_name,
+    operations,
+    can_fail=False,
+    raise_on_fail=True
+):
+    con = get_server_api_connection()
+    return con.send_batch_operations(
+        project_name,
+        operations,
+        can_fail=can_fail,
+        raise_on_fail=raise_on_fail
+    )

{ayon-python-api-0.1.16 → ayon-python-api-0.1.18}/ayon_api/constants.py

@@ -1,5 +1,8 @@
+# Environments where server url and api key are stored for global connection
 SERVER_URL_ENV_KEY = "AYON_SERVER_URL"
-SERVER_TOKEN_ENV_KEY = "AYON_TOKEN"
+SERVER_API_ENV_KEY = "AYON_API_KEY"
+# Backwards compatibility
+SERVER_TOKEN_ENV_KEY = SERVER_API_ENV_KEY
 
 # --- Project ---
 DEFAULT_PROJECT_FIELDS = {
@@ -102,4 +105,4 @@ DEFAULT_EVENT_FIELDS = {
     "topic",
     "updatedAt",
     "user",
-}
+}