Ayon-Python-Api 0.1.7__tar.gz → 0.1.9__tar.gz

{ayon-python-api-0.1.7/ayon_python_api.egg-info → ayon-python-api-0.1.9}/PKG-INFO

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

{ayon-python-api-0.1.7 → ayon-python-api-0.1.9}/ayon_api/__init__.py

@@ -1,5 +1,6 @@
 from .utils import (
     TransferProgress,
+    slugify_string,
 )
 from .server import (
     ServerAPIBase,
@@ -7,7 +8,14 @@ from .server import (
 
 from .server_api import (
     ServerAPI,
+    ServiceContext,
 
+    init_service,
+
+    is_connection_created,
+    close_connection,
+    change_token,
+    set_environments,
     get_server_api_connection,
 
     get_base_url,
@@ -25,6 +33,11 @@ from .server_api import (
     patch,
     delete,
 
+    get_event,
+    dispatch_event,
+    update_event,
+    enroll_event_job,
+
     download_file,
     upload_file,
 
@@ -99,11 +112,18 @@ from .server_api import (
 
 __all__ = (
     "TransferProgress",
+    "slugify_string",
 
     "ServerAPIBase",
 
     "ServerAPI",
+    "ServiceContext",
+    "init_service",
 
+    "is_connection_created",
+    "close_connection",
+    "change_token",
+    "set_environments",
     "get_server_api_connection",
 
     "get_base_url",
@@ -121,6 +141,11 @@ __all__ = (
     "patch",
     "delete",
 
+    "get_event",
+    "dispatch_event",
+    "update_event",
+    "enroll_event_job",
+
     "download_file",
     "upload_file",
 

{ayon-python-api-0.1.7 → ayon-python-api-0.1.9}/ayon_api/exceptions.py

@@ -90,4 +90,8 @@ class FolderNotFound(MissingEntityError):
 
 
 class FailedOperations(Exception):
+    pass
+
+
+class FailedServiceInit(Exception):
     pass

{ayon-python-api-0.1.7 → ayon-python-api-0.1.9}/ayon_api/server.py

@@ -75,13 +75,32 @@ class RequestTypes:
 class RestApiResponse(object):
     """API Response."""
 
-    def __init__(self, status_code, data=None, content=None, headers=None):
-        if data is None:
-            data = {}
+    def __init__(self, response, data=None):
+        if response is None:
+            status_code = 500
+        else:
+            status_code = response.status_code
+        self._response = response
         self.status = status_code
-        self.data = data
-        self.content = content
-        self.headers = headers or {}
+        self._data = data
+
+    @property
+    def orig_response(self):
+        return self._response
+
+    @property
+    def headers(self):
+        return self._response.headers
+
+    @property
+    def data(self):
+        if self._data is None:
+            self._data = self._response.json()
+        return self._data
+
+    @property
+    def content(self):
+        return self._response.content
 
     @property
     def content_type(self):
@@ -95,6 +114,12 @@ class RestApiResponse(object):
     def status_code(self):
         return self.status
 
+    def raise_for_status(self):
+        self._response.raise_for_status()
+
+    def __enter__(self, *args, **kwargs):
+        return self._response.__enter__(*args, **kwargs)
+
     def __contains__(self, key):
         return key in self.data
 
@@ -448,26 +473,22 @@ class ServerAPIBase(object):
 
         except ConnectionRefusedError:
             new_response = RestApiResponse(
-                500,
+                None,
                 {"detail": "Unable to connect the server. Connection refused"}
             )
         except requests.exceptions.ConnectionError:
             new_response = RestApiResponse(
-                500,
+                None,
                 {"detail": "Unable to connect the server. Connection error"}
             )
         else:
             content_type = response.headers.get("Content-Type")
             if content_type == "application/json":
                 try:
-                    new_response = RestApiResponse(
-                        response.status_code,
-                        response.json(),
-                        headers=response.headers,
-                    )
+                    new_response = RestApiResponse(response)
                 except JSONDecodeError:
                     new_response = RestApiResponse(
-                        500,
+                        None,
                         {
                             "detail": "The response is not a JSON: {}".format(
                                 response.text)
@@ -475,17 +496,10 @@ class ServerAPIBase(object):
                     )
 
             elif content_type in ("image/jpeg", "image/png"):
-                new_response = RestApiResponse(
-                    response.status_code,
-                    headers=response.headers,
-                    content=response.content
-                )
+                new_response = RestApiResponse(response)
 
             else:
-                new_response = RestApiResponse(
-                    response.status_code,
-                    headers=response.headers,
-                )
+                new_response = RestApiResponse(response)
 
         self.log.debug("Response {}".format(str(new_response)))
         return new_response
@@ -555,6 +569,119 @@ class ServerAPIBase(object):
     def delete(self, entrypoint, **kwargs):
         return self.raw_delete(entrypoint, params=kwargs)
 
+    def get_event(self, event_id):
+        """Receive full event data by id.
+
+        Events received using event server do not contain full information. To
+        get the full event information is required to receive it explicitly.
+
+        Args:
+            event_id (str): Id of event.
+
+        Returns:
+            Dict[str, Any]: Full event data.
+        """
+
+        response = self.get("events/{}".format(event_id))
+        response.raise_for_status()
+        return response.data
+
+    def update_event(
+        self,
+        event_id,
+        sender=None,
+        project_name=None,
+        status=None,
+        description=None,
+        summary=None,
+        payload=None
+    ):
+        kwargs = {}
+        for key, value in (
+            ("sender", sender),
+            ("projectName", project_name),
+            ("status", status),
+            ("description", description),
+            ("summary", summary),
+            ("payload", payload),
+        ):
+            if value is not None:
+                kwargs[key] = value
+        response = self.patch(
+            "events/{}".format(event_id),
+            **kwargs
+        )
+        response.raise_for_status()
+
+    def dispatch_event(
+        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 summary is None:
+            summary = {}
+        if payload is None:
+            payload = {}
+        event_data = {
+            "topic": topic,
+            "sender": sender,
+            "hash": event_hash,
+            "project": project_name,
+            "user": username,
+            "dependencies": dependencies,
+            "description": description,
+            "summary": summary,
+            "payload": payload,
+            "finished": finished,
+            "store": store,
+        }
+        if self.post("events", **event_data):
+            self.log.debug("Dispatched event {}".format(topic))
+            return True
+        self.log.error("Unable to dispatch event {}".format(topic))
+        return False
+
+    def enroll_event_job(
+        self,
+        source_topic,
+        target_topic,
+        sender,
+        description=None,
+        sequential=None
+    ):
+        """Enroll job based on events.
+
+        Args:
+            source_topic (str): Topic
+        """
+
+        kwargs = {
+            "sourceTopic": source_topic,
+            "targetTopic": target_topic,
+            "sender": sender,
+        }
+        if sequential is not None:
+            kwargs["sequential"] = sequential
+        if description is not None:
+            kwargs["description"] = description
+        response = self.post("enroll", **kwargs)
+        if response.status_code == 204:
+            return None
+        elif response.status_code >= 400:
+            self.log.error(response.text)
+            return None
+
+        return response.data
+
     def _download_file(self, url, filepath, chunk_size, progress):
         dst_directory = os.path.dirname(filepath)
         if not os.path.exists(dst_directory):
@@ -573,7 +700,7 @@ class ServerAPIBase(object):
                 progress.set_content_size(response.headers["Content-length"])
                 for chunk in response.iter_content(chunk_size=chunk_size):
                     f_stream.write(chunk)
-                    progress.add_downloaded_chunk(len(chunk))
+                    progress.add_transferred_chunk(len(chunk))
 
     def download_file(self, endpoint, filepath, chunk_size=None, progress=None):
         """Download file from AYON server.
@@ -618,7 +745,7 @@ class ServerAPIBase(object):
             raise
 
         finally:
-            progress.set_done()
+            progress.set_transfer_done()
 
     def _upload_file(self, url, filepath, progress):
         kwargs = {}
@@ -635,7 +762,7 @@ class ServerAPIBase(object):
             progress.set_content_size(size)
             response = post_func(url, data=stream, **kwargs)
         response.raise_for_status()
-        progress.set_downloaded_size(size)
+        progress.set_transferred_size(size)
 
     def upload_file(self, endpoint, filepath, progress=None):
         """Upload file to server.
@@ -673,7 +800,7 @@ class ServerAPIBase(object):
             raise
 
         finally:
-            progress.set_done()
+            progress.set_transfer_done()
 
     def trigger_server_restart(self):
         result = self.post("system/restart")
@@ -889,8 +1016,7 @@ class ServerAPIBase(object):
         if details:
             endpoint += "?details=1"
         response = self.get(endpoint)
-        if response.status != 200:
-            raise ServerError(response.text)
+        response.raise_for_status()
         return response.data
 
     def download_addon_private_file(
@@ -1106,8 +1232,7 @@ class ServerAPIBase(object):
         result = self.get(
             "addons/{}/{}/settings".format(addon_name, addon_version)
         )
-        if result.status != 200:
-            raise ServerError(result.text)
+        result.raise_for_status()
         return result.data
 
     def get_addon_project_settings(
@@ -1118,8 +1243,7 @@ class ServerAPIBase(object):
                 addon_name, addon_version, project_name
             )
         )
-        if result.status != 200:
-            raise ServerError(result.text)
+        result.raise_for_status()
         return result.data
 
     def get_addon_settings(self, addon_name, addon_version, project_name=None):
@@ -1160,7 +1284,7 @@ class ServerAPIBase(object):
                 returned if 'None' is passed.
 
         Returns:
-            List[Dict[str, Any]]: List of available projects.
+            Generator[Dict[str, Any]]: Available projects.
         """
 
         for project_name in self.get_project_names(active, library):
@@ -1223,8 +1347,7 @@ class ServerAPIBase(object):
             ]))
 
         response = self.get("projects{}".format(query), **query_keys)
-        # TODO check status
-        response.status
+        response.raise_for_status()
         data = response.data
         project_names = []
         if data:
@@ -1248,7 +1371,7 @@ class ServerAPIBase(object):
                 on entity will have 'None' value.
 
         Returns:
-            List[Dict[str, Any]]: List of queried projects.
+            Generator[Dict[str, Any]]: Queried projects.
         """
 
         if fields is None:
@@ -1357,11 +1480,11 @@ class ServerAPIBase(object):
                 if 'None' is passed.
 
         Returns:
-            Iterable[dict[str, Any]]: Queried folder entities.
+            Generator[dict[str, Any]]: Queried folder entities.
         """
 
         if not project_name:
-            return []
+            return
 
         filters = {
             "projectName": project_name
@@ -1369,25 +1492,25 @@ class ServerAPIBase(object):
         if folder_ids is not None:
             folder_ids = set(folder_ids)
             if not folder_ids:
-                return []
+                return
             filters["folderIds"] = list(folder_ids)
 
         if folder_paths is not None:
             folder_paths = set(folder_paths)
             if not folder_paths:
-                return []
+                return
             filters["folderPaths"] = list(folder_paths)
 
         if folder_names is not None:
             folder_names = set(folder_names)
             if not folder_names:
-                return []
+                return
             filters["folderNames"] = list(folder_names)
 
         if parent_ids is not None:
             parent_ids = set(parent_ids)
             if not parent_ids:
-                return []
+                return
             if None in parent_ids:
                 # Replace 'None' with '"root"' which is used during GraphQl
                 #   query for parent ids filter for folders without folder
@@ -1448,7 +1571,7 @@ class ServerAPIBase(object):
         own_attributes=False
     ):
         if not project_name:
-            return []
+            return
 
         filters = {
             "projectName": project_name
@@ -1457,25 +1580,25 @@ class ServerAPIBase(object):
         if task_ids is not None:
             task_ids = set(task_ids)
             if not task_ids:
-                return []
+                return
             filters["taskIds"] = list(task_ids)
 
         if task_names is not None:
             task_names = set(task_names)
             if not task_names:
-                return []
+                return
             filters["taskNames"] = list(task_names)
 
         if task_types is not None:
             task_types = set(task_types)
             if not task_types:
-                return []
+                return
             filters["taskTypes"] = list(task_types)
 
         if folder_ids is not None:
             folder_ids = set(folder_ids)
             if not folder_ids:
-                return []
+                return
             filters["folderIds"] = list(folder_ids)
 
         if not fields:
@@ -1633,6 +1756,20 @@ class ServerAPIBase(object):
             for folder in folders
         }
 
+    def _filter_subset(
+        self, project_name, subset, active, own_attributes, use_rest
+    ):
+        if active is not None and subset["active"] is not active:
+            return None
+
+        if use_rest:
+            subset = self.get_rest_subset(project_name, subset["id"])
+
+        if own_attributes:
+            fill_own_attribs(subset)
+
+        return subset
+
     def get_subsets(
         self,
         project_name,
@@ -1645,24 +1782,24 @@ class ServerAPIBase(object):
         own_attributes=False
     ):
         if not project_name:
-            return []
+            return
 
         if subset_ids is not None:
             subset_ids = set(subset_ids)
             if not subset_ids:
-                return []
+                return
 
         filter_subset_names = None
         if subset_names is not None:
             filter_subset_names = set(subset_names)
             if not filter_subset_names:
-                return []
+                return
 
         filter_folder_ids = None
         if folder_ids is not None:
             filter_folder_ids = set(folder_ids)
             if not filter_folder_ids:
-                return []
+                return
 
         # This will disable 'folder_ids' and 'subset_names' filters
         #   - maybe could be enhanced in future?
@@ -1676,7 +1813,7 @@ class ServerAPIBase(object):
                     filter_subset_names |= set(names)
 
             if not filter_subset_names or not filter_folder_ids:
-                return []
+                return
 
         # Convert fields and add minimum required fields
         if fields:
@@ -1720,35 +1857,30 @@ class ServerAPIBase(object):
         parsed_data = query.query(self)
 
         subsets = parsed_data.get("project", {}).get("subsets", [])
-        if active is not None or own_attributes:
-            _subsets = []
-            for subset in subsets:
-                if active is not None and subset["active"] is not active:
-                    continue
-
-                if use_rest:
-                    subset = self.get_rest_subset(project_name, subset["id"])
-
-                if own_attributes:
-                    fill_own_attribs(subset)
-                _subsets.append(subset)
-            subsets = _subsets
-
         # Filter subsets by 'names_by_folder_ids'
         if names_by_folder_ids:
             subsets_by_folder_id = collections.defaultdict(list)
             for subset in subsets:
-                folder_id = subset["folderId"]
-                subsets_by_folder_id[folder_id].append(subset)
+                filtered_subset = self._filter_subset(
+                    project_name, subset, active, own_attributes, use_rest
+                )
+                if filtered_subset is not None:
+                    folder_id = filtered_subset["folderId"]
+                    subsets_by_folder_id[folder_id].append(filtered_subset)
 
-            filtered_subsets = []
             for folder_id, names in names_by_folder_ids.items():
                 for folder_subset in subsets_by_folder_id[folder_id]:
                     if folder_subset["name"] in names:
-                        filtered_subsets.append(subset)
-            subsets = filtered_subsets
+                        yield folder_subset
+
+        else:
+            for subset in subsets:
+                filtered_subset = self._filter_subset(
+                    project_name, subset, active, own_attributes, use_rest
+                )
+                if filtered_subset is not None:
+                    yield filtered_subset
 
-        return list(subsets)
 
     def get_subset_by_id(
         self,
@@ -1845,7 +1977,7 @@ class ServerAPIBase(object):
                 if 'None' is passed.
 
         Returns:
-            List[Dict[str, Any]]: Queried version entities.
+            Generator[Dict[str, Any]]: Queried version entities.
         """
 
         if not fields:
@@ -1872,24 +2004,24 @@ class ServerAPIBase(object):
         if version_ids is not None:
             version_ids = set(version_ids)
             if not version_ids:
-                return []
+                return
             filters["versionIds"] = list(version_ids)
 
         if subset_ids is not None:
             subset_ids = set(subset_ids)
             if not subset_ids:
-                return []
+                return
             filters["subsetIds"] = list(subset_ids)
 
         # TODO versions can't be used as fitler at this moment!
         if versions is not None:
             versions = set(versions)
             if not versions:
-                return []
+                return
             filters["versions"] = list(versions)
 
         if not hero and not standard:
-            return []
+            return
 
         queries = []
         # Add filters based on 'hero' and 'standard'
@@ -2158,7 +2290,7 @@ class ServerAPIBase(object):
                 passed.
 
         Returns:
-            List[Dict[str, Any]]: Queried representation entities.
+            Generator[Dict[str, Any]]: Queried representation entities.
         """
 
         if not fields:
@@ -2183,7 +2315,7 @@ class ServerAPIBase(object):
         if representation_ids is not None:
             representation_ids = set(representation_ids)
             if not representation_ids:
-                return []
+                return
             filters["representationIds"] = list(representation_ids)
 
         version_ids_filter = None
@@ -2196,18 +2328,18 @@ class ServerAPIBase(object):
                 representaion_names_filter |= set(names)
 
             if not version_ids_filter or not representaion_names_filter:
-                return []
+                return
 
         else:
             if representation_names is not None:
                 representaion_names_filter = set(representation_names)
                 if not representaion_names_filter:
-                    return []
+                    return
 
             if version_ids is not None:
                 version_ids_filter = set(version_ids)
                 if not version_ids_filter:
-                    return []
+                    return
 
         if version_ids_filter:
             filters["versionIds"] = list(version_ids_filter)
@@ -2332,19 +2464,19 @@ class ServerAPIBase(object):
         if task_ids is not None:
             task_ids = set(task_ids)
             if not task_ids:
-                return []
+                return
             filters["taskIds"] = list(task_ids)
 
         if paths is not None:
             paths = set(paths)
             if not paths:
-                return []
+                return
             filters["paths"] = list(paths)
 
         if workfile_ids is not None:
             workfile_ids = set(workfile_ids)
             if not workfile_ids:
-                return []
+                return
             filters["workfileIds"] = list(workfile_ids)
 
         if not fields:
@@ -2722,4 +2854,5 @@ class ServerAPIBase(object):
                     operation_id,
                     json.dumps(body_by_id[operation_id], indent=4),
                     op_result["error"],
-                ))
+                ))
+

{ayon-python-api-0.1.7 → ayon-python-api-0.1.9}/ayon_api/server_api.py

@@ -1,9 +1,12 @@
 import os
+import socket
+
 from .constants import (
     SERVER_URL_ENV_KEY,
     SERVER_TOKEN_ENV_KEY,
 )
 from .server import ServerAPIBase
+from .exceptions import FailedServiceInit
 
 
 class ServerAPI(ServerAPIBase):
@@ -65,6 +68,27 @@ class GlobalContext:
 
     _connection = None
 
+    @classmethod
+    def is_connection_created(cls):
+        return cls._connection is not None
+
+    @classmethod
+    def change_token(cls, url, token):
+        ServerAPI.set_environments(url, token)
+        if cls._connection is None:
+            return
+
+        if cls._connection.get_base_url() == url:
+            cls._connection.set_token(token)
+        else:
+            cls.close_connection()
+
+    @classmethod
+    def close_connection(cls):
+        if cls._connection is not None:
+            cls._connection.close_session()
+        cls._connection = None
+
     @classmethod
     def get_server_api_connection(cls):
         if cls._connection is None:
@@ -72,6 +96,134 @@ class GlobalContext:
         return cls._connection
 
 
+class ServiceContext:
+    """Helper for services running under server.
+
+    When service is running from server the process receives information about
+    connection from environment variables. This class helps to initialize the
+    values without knowing environment variables (that may change over time).
+
+    All what must be done is to call 'init_service' function/method. The
+    arguments are for cases when the service is running in specific environment
+    and their values are e.g. loaded from private file or for testing purposes.
+    """
+
+    token = None
+    server_url = None
+    addon_name = None
+    addon_version = None
+    service_name = None
+
+    @staticmethod
+    def get_value_from_envs(env_keys, value=None):
+        if value:
+            return value
+
+        for env_key in env_keys:
+            value = os.environ.get(env_key)
+            if value:
+                break
+        return value
+
+    @classmethod
+    def init_service(
+        cls,
+        token=None,
+        server_url=None,
+        addon_name=None,
+        addon_version=None,
+        service_name=None,
+        connect=True
+    ):
+        token = cls.get_value_from_envs(
+            ("AY_API_KEY", "AYON_TOKEN"),
+            token
+        )
+        server_url = cls.get_value_from_envs(
+            ("AY_SERVER_URL", "AYON_SERVER_URL"),
+            server_url
+        )
+        if not server_url:
+            raise FailedServiceInit("URL to server is not set")
+
+        if not token:
+            raise FailedServiceInit(
+                "Token to server {} is not set".format(server_url)
+            )
+
+        addon_name = cls.get_value_from_envs(
+            ("AY_ADDON_NAME", "AYON_ADDON_NAME"),
+            addon_name
+        )
+        addon_version = cls.get_value_from_envs(
+            ("AY_ADDON_VERSION", "AYON_ADDON_VERSION"),
+            addon_version
+        )
+        service_name = cls.get_value_from_envs(
+            ("AY_SERVICE_NAME", "AYON_SERVICE_NAME"),
+            service_name
+        )
+
+        cls.token = token
+        cls.server_url = server_url
+        cls.addon_name = addon_name
+        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)
+
+        if connect:
+            print("Connecting to server \"{}\"".format(server_url))
+            con = GlobalContext.get_server_api_connection()
+            user = con.get_user()
+            print("Logged in as user \"{}\"".format(user["name"]))
+
+
+def init_service(*args, **kwargs):
+    ServiceContext.init_service(*args, **kwargs)
+
+
+def is_connection_created():
+    """Is global connection created.
+
+    Returns:
+        bool: True if connection was connected.
+    """
+
+    return GlobalContext.is_connection_created()
+
+
+def close_connection():
+    """Close global connection if is connected."""
+
+    GlobalContext.close_connection()
+
+
+def change_token(url, token):
+    """Change connection token for url.
+
+    This function can be also used to change url.
+
+    Args:
+        url (str): Server url.
+        token (str): API key token.
+    """
+
+    GlobalContext.change_token(url, token)
+
+
+def set_environments(url, token):
+    """Set global environments for global connection.
+
+    Args:
+        url (Union[str, None]): Url to server or None to unset environments.
+        token (Union[str, None]): API key token to be used for connection.
+    """
+
+    ServerAPI.set_environments(url, token)
+
+
 def get_server_api_connection():
     """Access to global scope object of ServerAPI.
 
@@ -145,6 +297,26 @@ def delete(*args, **kwargs):
     return con.delete(*args, **kwargs)
 
 
+def get_event(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_event(*args, **kwargs)
+
+
+def dispatch_event(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.dispatch_event(*args, **kwargs)
+
+
+def update_event(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.update_event(*args, **kwargs)
+
+
+def enroll_event_job(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.enroll_event_job(*args, **kwargs)
+
+
 def download_file(*args, **kwargs):
     con = get_server_api_connection()
     return con.download_file(*args, **kwargs)

{ayon-python-api-0.1.7 → ayon-python-api-0.1.9}/ayon_api/utils.py

@@ -1,15 +1,21 @@
+import re
 import datetime
 import uuid
+import string
 try:
     from urlparse import urlparse
 except ImportError:
     from urllib.parse import urlparse
 
 import requests
+import unidecode
+
 
 from .exceptions import UrlError
 
 REMOVED_VALUE = object()
+SLUGIFY_WHITELIST = string.ascii_letters + string.digits
+SLUGIFY_SEP_WHITELIST = " ,./\\;:!|*^#@~+-_="
 
 
 def create_entity_id():
@@ -47,6 +53,59 @@ def entity_data_json_default(value):
     )
 
 
+def slugify_string(
+    input_string,
+    separator="_",
+    slug_whitelist=SLUGIFY_WHITELIST,
+    split_chars=SLUGIFY_SEP_WHITELIST,
+    min_length=1,
+    lower=False,
+    make_set=False,
+):
+    """Slugify a text string.
+
+    This function removes transliterates input string to ASCII, removes
+    special characters and use join resulting elements using
+    specified separator.
+
+    Args:
+        input_string (str): Input string to slugify
+        separator (str): A string used to separate returned elements
+            (default: "_")
+        slug_whitelist (str): Characters allowed in the output
+            (default: ascii letters, digits and the separator)
+        split_chars (str): Set of characters used for word splitting
+            (there is a sane default)
+        lower (bool): Convert to lower-case (default: False)
+        make_set (bool): Return "set" object instead of string.
+        min_length (int): Minimal length of an element (word).
+
+    Returns:
+        Union[str, Set[str]]: Based on 'make_set' value returns slugified
+            string.
+    """
+
+    tmp_string = unidecode.unidecode(input_string)
+    if lower:
+        tmp_string = tmp_string.lower()
+
+    parts = [
+        # Remove all characters that are not in whitelist
+        re.sub("[^{}]".format(re.escape(slug_whitelist)), "", part)
+        # Split text into part by split characters
+        for part in re.split("[{}]".format(re.escape(split_chars)), tmp_string)
+    ]
+    # Filter text parts by length
+    filtered_parts = [
+        part
+        for part in parts
+        if len(part) >= min_length
+    ]
+    if make_set:
+        return set(filtered_parts)
+    return separator.join(filtered_parts)
+
+
 def failed_json_default(value):
     return "< Failed value {} > {}".format(type(value), str(value))
 
@@ -272,8 +331,8 @@ class TransferProgress:
 
     def __init__(self):
         self._started = False
-        self._done = False
-        self._downloaded = 0
+        self._transfer_done = False
+        self._transfered = 0
         self._content_size = None
 
         self._failed = False
@@ -298,15 +357,15 @@ class TransferProgress:
             raise ValueError("Progress already started")
         self._started = True
 
-    def get_done(self):
-        return self._done
+    def get_transfer_done(self):
+        return self._transfer_done
 
-    def set_done(self):
-        if self._done:
+    def set_transfer_done(self):
+        if self._transfer_done:
             raise ValueError("Progress was already marked as done")
         if not self._started:
             raise ValueError("Progress didn't start yet")
-        self._done = True
+        self._transfer_done = True
 
     def get_failed(self):
         return self._failed
@@ -318,14 +377,14 @@ class TransferProgress:
         self._fail_reason = reason
         self._failed = True
 
-    def get_downloaded_size(self):
-        return self._downloaded
+    def get_transferred_size(self):
+        return self._transfered
 
-    def set_downloaded_size(self, downloaded_size):
-        self._downloaded = downloaded_size
+    def set_transferred_size(self, transfered):
+        self._transfered = transfered
 
-    def add_downloaded_chunk(self, chunk_size):
-        self._downloaded += chunk_size
+    def add_transferred_chunk(self, chunk_size):
+        self._transfered += chunk_size
 
     def get_source_url(self):
         return self._source_url
@@ -350,17 +409,17 @@ class TransferProgress:
         return True
 
     @property
-    def progress(self):
+    def transfer_progress(self):
         if self._content_size is None:
             return None
-        return (self._downloaded * 100.0) / float(self._content_size)
+        return (self._transfered * 100.0) / float(self._content_size)
 
     content_size = property(get_content_size, set_content_size)
     started = property(get_started)
-    done = property(get_done)
+    transfer_done = property(get_transfer_done)
     failed = property(get_failed)
     fail_reason = property(get_fail_reason)
     source_url = property(get_source_url, set_source_url)
     destination_url = property(get_destination_url, set_destination_url)
     content_size = property(get_content_size, set_content_size)
-    downloaded_size = property(get_downloaded_size, set_downloaded_size)
+    transferred_size = property(get_transferred_size, set_transferred_size)

{ayon-python-api-0.1.7 → ayon-python-api-0.1.9}/ayon_api/version.py

@@ -1,2 +1,2 @@
 """Package declaring Python API for Ayon server."""
-__version__ = "0.1.7"
+__version__ = "0.1.9"

{ayon-python-api-0.1.7 → ayon-python-api-0.1.9/ayon_python_api.egg-info}/PKG-INFO

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

ayon-python-api-0.1.9/ayon_python_api.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ayon-python-api-0.1.9/ayon_python_api.egg-info/requires.txt

@@ -0,0 +1,4 @@
+requests>=2.27.1
+six>=1.15
+Unidecode>=1.3.6
+appdirs<2,>=1

{ayon-python-api-0.1.7 → ayon-python-api-0.1.9}/pyproject.toml

@@ -1,13 +1,14 @@
 [tool.poetry]
 name = "ayon_api"
-version = "0.1.7"
+version = "0.1.9"
 description = "Python api for AYON server"
 authors = ["ynput.io <info@ynput.io>"]
 
 [tool.poetry.dependencies]
 requests = "^2.28.1"
 six = "^1.15"
-appdirs = { git = "https://github.com/ActiveState/appdirs.git", branch = "master" }
+Unidecode = "^1.3"
+appdirs = "^1.4"
 
 [tool.poetry.dev-dependencies]
 pytest = "^5.2"

{ayon-python-api-0.1.7 → ayon-python-api-0.1.9}/setup.py

@@ -30,9 +30,8 @@ setup(
     install_requires=[
         "requests >= 2.27.1",
         "six >= 1.15",
-    ],
-    dependency_links=[
-        "appdirs @ git+https://github.com/ActiveState/appdirs.git@master"
+        "Unidecode >= 1.3.6",
+        "appdirs >=1, <2",
     ],
     keywords=["AYON", "ynput", "OpenPype", "vfx"],
 )

ayon-python-api-0.1.7/ayon_python_api.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-appdirs @ git+https://github.com/ActiveState/appdirs.git@master

ayon-python-api-0.1.7/ayon_python_api.egg-info/requires.txt

@@ -1,2 +0,0 @@
-requests>=2.27.1
-six>=1.15