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

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

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

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

@@ -1,3 +1,6 @@
+from .utils import (
+    TransferProgress,
+)
 from .server import (
     ServerAPIBase,
 )
@@ -7,12 +10,51 @@ from .server_api import (
 
     get_server_api_connection,
 
+    get_base_url,
+    get_rest_url,
+
+    raw_get,
+    raw_post,
+    raw_put,
+    raw_patch,
+    raw_delete,
+
     get,
     post,
     put,
     patch,
     delete,
 
+    download_file,
+    upload_file,
+
+    query_graphql,
+
+    get_addons_info,
+    download_addon_private_file,
+
+    get_dependencies_info,
+    update_dependency_info,
+
+    download_dependency_package,
+    upload_dependency_package,
+    delete_dependency_package,
+
+    get_full_production_settings,
+    get_production_settings,
+    get_full_project_settings,
+    get_project_settings,
+    get_addon_settings,
+
+    get_user,
+    get_users,
+
+    get_attributes_for_type,
+    get_default_fields_for_type,
+
+    get_project_anatomy_preset,
+    get_project_anatomy_presets,
+
     get_projects,
     get_project,
     create_project,
@@ -47,9 +89,6 @@ from .server_api import (
     get_representations_parents,
     get_representation_parents,
 
-    get_project_settings,
-    get_addon_settings,
-
     create_thumbnail,
     get_thumbnail,
     get_folder_thumbnail,
@@ -59,19 +98,59 @@ from .server_api import (
 
 
 __all__ = (
+    "TransferProgress",
+
     "ServerAPIBase",
 
     "ServerAPI",
+
     "get_server_api_connection",
+
+    "get_base_url",
+    "get_rest_url",
+
+    "raw_get",
+    "raw_post",
+    "raw_put",
+    "raw_patch",
+    "raw_delete",
+
     "get",
     "post",
     "put",
     "patch",
     "delete",
 
+    "download_file",
+    "upload_file",
+
+    "query_graphql",
+
+    "get_addons_info",
+    "download_addon_private_file",
+
+    "get_dependencies_info",
+    "update_dependency_info",
+
+    "download_dependency_package",
+    "upload_dependency_package",
+    "delete_dependency_package",
+
+    "get_full_production_settings",
+    "get_production_settings",
+    "get_full_project_settings",
     "get_project_settings",
     "get_addon_settings",
 
+    "get_user",
+    "get_users",
+
+    "get_attributes_for_type",
+    "get_default_fields_for_type",
+
+    "get_project_anatomy_preset",
+    "get_project_anatomy_presets",
+
     "get_projects",
     "get_project",
     "create_project",
@@ -89,6 +168,7 @@ __all__ = (
     "get_subset_by_name",
     "get_subsets",
     "get_subset_families",
+
     "get_version_by_id",
     "get_version_by_name",
     "version_is_latest",

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

@@ -1,8 +1,10 @@
 import os
 import re
+import io
 import json
 import logging
 import collections
+import platform
 import copy
 from http import HTTPStatus
 
@@ -36,12 +38,14 @@ from .exceptions import (
     UnauthorizedError,
     AuthenticationError,
     ServerNotReached,
+    ServerError,
 )
 from .utils import (
     logout_from_server,
     create_entity_id,
     entity_data_json_default,
-    failed_json_default
+    failed_json_default,
+    TransferProgress,
 )
 
 JSONDecodeError = getattr(json, "JSONDecodeError", ValueError)
@@ -151,10 +155,21 @@ class ServerAPIBase(object):
     Login cause that a session is used
 
     Args:
-        base_url(str): Example: http://localhost:5000
+        base_url (str): Example: http://localhost:5000
+        token (str): Access token (api key) to server.
+        site_id (str): Unique name of site. Should be the same when
+            connection is created from the same machine under same user.
+        client_version (str): Version of client application (used in
+            desktop client application).
     """
 
-    def __init__(self, base_url, token=None):
+    def __init__(
+        self,
+        base_url,
+        token=None,
+        site_id=None,
+        client_version=None
+    ):
         if not base_url:
             raise ValueError("Invalid server URL {}".format(str(base_url)))
 
@@ -164,6 +179,8 @@ class ServerAPIBase(object):
         self._graphl_url = "{}/graphql".format(base_url)
         self._log = None
         self._access_token = token
+        self._site_id = site_id
+        self._client_version = client_version
         self._access_token_is_service = None
         self._token_is_valid = None
         self._server_available = None
@@ -185,10 +202,33 @@ class ServerAPIBase(object):
 
         self._thumbnail_cache = ThumbnailCache(True)
 
+    def get_base_url(self):
+        return self._base_url
+
+    def get_rest_url(self):
+        return self._rest_url
+
+    base_url = property(get_base_url)
+    rest_url = property(get_rest_url)
+
     @property
     def access_token(self):
         return self._access_token
 
+    def get_site_id(self):
+        return self._site_id
+
+    def set_site_id(self, site_id):
+        if self._site_id == site_id:
+            return
+        self._site_id = site_id
+        # Recreate session on machine id change
+        if self._session is not None:
+            self.close_session()
+            self.create_session()
+
+    site_id = property(get_site_id, set_site_id)
+
     @property
     def is_server_available(self):
         if self._server_available is None:
@@ -213,7 +253,11 @@ class ServerAPIBase(object):
 
     def validate_token(self):
         try:
-            self.get_user_info()
+            # TODO add other possible validations
+            # - existence of 'user' key in info
+            # - validate that 'site_id' is in 'sites' in info
+            self.get_info()
+            self.get_user()
             self._token_is_valid = True
 
         except UnauthorizedError:
@@ -223,7 +267,7 @@ class ServerAPIBase(object):
     def set_token(self, token):
         self.reset_token()
         self._access_token = token
-        self.get_user_info()
+        self.get_user()
 
     def reset_token(self):
         self._access_token = None
@@ -258,6 +302,23 @@ class ServerAPIBase(object):
         self._session_functions_mapping = {}
         session.close()
 
+    def get_info(self):
+        """Get information about current used api key.
+
+        By default, the 'info' contains only 'uptime' and 'version'. With
+        logged user info also contains information about user and machines on
+        which was logged in.
+
+        Todos:
+            Use this method for validation of token instead of 'get_user'.
+
+        Returns:
+            Dict[str, Any]: Information from server.
+        """
+
+        response = self.get("info")
+        return response.data
+
     def _get_user_info(self):
         if self._access_token is None:
             return None
@@ -279,11 +340,23 @@ class ServerAPIBase(object):
         self._access_token_is_service = None
         return None
 
-    def get_user_info(self):
-        user_info = self._get_user_info()
-        if user_info is None:
+    def get_users(self):
+        # TODO how to find out if user have permission?
+        users = self.get("users")
+        return users.data
+
+    def get_user(self, username=None):
+        output = None
+        if username is None:
+            output = self._get_user_info()
+        else:
+            response = self.get("users/{}".format(username))
+            if response.status == 200:
+                output = response.data
+
+        if output is None:
             raise UnauthorizedError("User is not authorized.")
-        return user_info
+        return output
 
     @property
     def log(self):
@@ -294,7 +367,18 @@ class ServerAPIBase(object):
     def get_headers(self, content_type=None):
         if content_type is None:
             content_type = "application/json"
-        headers = {"Content-Type": content_type}
+
+        headers = {
+            "Content-Type": content_type,
+            "x-ayon-platform": platform.system().lower(),
+            "x-ayon-hostname": platform.node(),
+        }
+        if self._site_id is not None:
+            headers["x-ayon-site-id"] = self._site_id
+
+        if self._client_version is not None:
+            headers["x-ayon-version"] = self._client_version
+
         if self._access_token:
             if self._access_token_is_service:
                 headers["X-Api-Key"] = self._access_token
@@ -306,7 +390,7 @@ class ServerAPIBase(object):
     def login(self, username, password):
         if self.has_valid_token:
             try:
-                user_info = self.get_user_info()
+                user_info = self.get_user()
             except UnauthorizedError:
                 user_info = {}
 
@@ -471,6 +555,126 @@ class ServerAPIBase(object):
     def delete(self, entrypoint, **kwargs):
         return self.raw_delete(entrypoint, params=kwargs)
 
+    def _download_file(self, url, filepath, chunk_size, progress):
+        dst_directory = os.path.dirname(filepath)
+        if not os.path.exists(dst_directory):
+            os.makedirs(dst_directory)
+
+        kwargs = {"stream": True}
+        if self._session is None:
+            kwargs["headers"] = self.get_headers()
+            get_func = self._base_functions_mapping[RequestTypes.get]
+        else:
+            get_func = self._session_functions_mapping[RequestTypes.get]
+
+        with open(filepath, "wb") as f_stream:
+            with get_func(url, **kwargs) as response:
+                response.raise_for_status()
+                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))
+
+    def download_file(self, endpoint, filepath, chunk_size=None, progress=None):
+        """Download file from AYON server.
+
+        Endpoint can be full url (must start with 'base_url' of api object).
+
+        Progress object can be used to track download. Can be used when
+        download happens in thread and other thread want to catch changes over
+        time.
+
+        Args:
+            endpoint (str): Endpoint or URL to file that should be downloaded.
+            filepath (str): Path where file will be downloaded.
+            chunk_size (int): Size of chunks that are received in single loop.
+            progress (TransferProgress): Object that gives ability to track
+                download progress.
+        """
+
+        if not chunk_size:
+            # 1 MB chunk by default
+            chunk_size = 1024 * 1024
+
+        if endpoint.startswith(self._base_url):
+            url = endpoint
+        else:
+            endpoint = endpoint.lstrip("/").rstrip("/")
+            url = "{}/{}".format(self._rest_url, endpoint)
+
+        # Create dummy object so the function does not have to check
+        #   'progress' variable everywhere
+        if progress is None:
+            progress = TransferProgress()
+
+        progress.set_source_url(url)
+        progress.set_destination_url(filepath)
+        progress.set_started()
+        try:
+            self._download_file(url, filepath, chunk_size, progress)
+
+        except Exception as exc:
+            progress.set_failed(str(exc))
+            raise
+
+        finally:
+            progress.set_done()
+
+    def _upload_file(self, url, filepath, progress):
+        kwargs = {}
+        if self._session is None:
+            kwargs["headers"] = self.get_headers()
+            post_func = self._base_functions_mapping[RequestTypes.post]
+        else:
+            post_func = self._session_functions_mapping[RequestTypes.post]
+
+        with open(filepath, "rb") as stream:
+            stream.seek(0, io.SEEK_END)
+            size = stream.tell()
+            stream.seek(0)
+            progress.set_content_size(size)
+            response = post_func(url, data=stream, **kwargs)
+        response.raise_for_status()
+        progress.set_downloaded_size(size)
+
+    def upload_file(self, endpoint, filepath, progress=None):
+        """Upload file to server.
+
+        Todos:
+            Uploading with more detailed progress.
+
+        Args:
+            endpoint (str): Endpoint or url where file will be uploaded.
+            filepath (str): Source filepath.
+            progress (TransferProgress): Object that gives ability to track
+                upload progress.
+        """
+
+        if endpoint.startswith(self._base_url):
+            url = endpoint
+        else:
+            endpoint = endpoint.lstrip("/").rstrip("/")
+            url = "{}/{}".format(self._rest_url, endpoint)
+
+        # Create dummy object so the function does not have to check
+        #   'progress' variable everywhere
+        if progress is None:
+            progress = TransferProgress()
+
+        progress.set_source_url(filepath)
+        progress.set_destination_url(url)
+        progress.set_started()
+
+        try:
+            self._upload_file(url, filepath, progress)
+
+        except Exception as exc:
+            progress.set_failed(str(exc))
+            raise
+
+        finally:
+            progress.set_done()
+
     def trigger_server_restart(self):
         result = self.post("system/restart")
         if result.status_code != 204:
@@ -673,6 +877,191 @@ class ServerAPIBase(object):
                 }
             )
 
+    def get_addons_info(self, details=True):
+        """Get information about addons available on server.
+
+        Args:
+            details (bool): Detailed data with information how to get client
+                code.
+        """
+
+        endpoint = "addons"
+        if details:
+            endpoint += "?details=1"
+        response = self.get(endpoint)
+        if response.status != 200:
+            raise ServerError(response.text)
+        return response.data
+
+    def download_addon_private_file(
+        self,
+        addon_name,
+        addon_version,
+        filename,
+        destination_dir,
+        destination_filename=None,
+        chunk_size=None,
+        progress=None,
+    ):
+        """Download a file from addon private files.
+
+        This method requires to have authorized token available. Private files
+        are not under '/api' restpoint.
+
+        Args:
+            addon_name (str): Addon name.
+            addon_version (str): Addon version.
+            filename (str): Filename in private folder on server.
+            destination_dir (str): Where the file should be downloaded.
+            destination_filename (str): Name of destination filename. Source
+                filename is used if not passed.
+            chunk_size (int): Download chunk size.
+            progress (TransferProgress): Object that gives ability to track
+                download progress.
+
+        Returns:
+            str: Filepath to downloaded file.
+        """
+
+        if not destination_filename:
+            destination_filename = filename
+        dst_filepath = os.path.join(destination_dir, destination_filename)
+        # Filename can contain "subfolders"
+        dst_dirpath = os.path.dirname(dst_filepath)
+        if not os.path.exists(dst_dirpath):
+            os.makedirs(dst_dirpath)
+
+        url = "{}/addons/{}/{}/private/{}".format(
+            self._base_url,
+            addon_name,
+            addon_version,
+            filename
+        )
+        self.download_file(
+            url, dst_filepath, chunk_size=chunk_size, progress=progress
+        )
+        return dst_filepath
+
+    def get_dependencies_info(self):
+        result = self.get("dependencies")
+        return result.data
+
+    def update_dependency_info(
+        self,
+        name,
+        platform_name,
+        size,
+        checksum,
+        checksum_algorithm=None,
+        supported_addons=None,
+        python_modules=None,
+        sources=None
+    ):
+        """Update or create dependency package infor by it's identifiers.
+
+        The endpoint can be used to create or update dependency package.
+
+        Args:
+            name (str): Name of dependency package.
+            platform_name (Literal["windows", "linux", "darwin"]): Platform for
+                which is dependency package targeted.
+            size (int): Size of dependency package in bytes.
+            checksum (str): Checksum of archive file where dependecies are.
+            checksum_algorithm (str): Algorithm used to calculate checksum.
+                By default, is used 'md5' (defined by server).
+            supported_addons (Dict[str, str]): Name of addons for which was the
+                package created ('{"<addon name>": "<addon version>", ...}').
+            python_modules (Dict[str, str]): Python modules in dependencies
+                package ('{"<module name>": "<module version>", ...}').
+            sources (List[Dict[str, Any]]): Information about sources where
+                dependency package is available.
+        """
+
+        kwargs = {
+            key: value
+            for key, value in (
+                ("checksumAlgorithm", checksum_algorithm),
+                ("supportedAddons", supported_addons),
+                ("pythonModules", python_modules),
+                ("sources", sources),
+            )
+            if value
+        }
+
+        response = self.put(
+            "dependencies",
+            name=name,
+            platform=platform_name,
+            size=size,
+            checksum=checksum,
+            **kwargs
+        )
+        if response.status not in (200, 201):
+            raise ServerError("Failed to create/update dependency")
+        return response.data
+
+    def download_dependency_package(
+        self,
+        package_name,
+        dst_directory,
+        filename,
+        platform_name=None,
+        chunk_size=None,
+        progress=None,
+    ):
+        """Download dependency package from server.
+
+        This method requires to have authorized token available. The package is
+        only downloaded.
+
+        Args:
+            package_name (str): Name of package to download.
+            dst_directory (str): Where the file should be downloaded.
+            filename (str): Name of destination filename.
+            platform_name (str): Name of platform for which the dependency
+                package is targetter. Default value is current platform.
+            chunk_size (int): Download chunk size.
+            progress (TransferProgress): Object that gives ability to track
+                download progress.
+
+        Returns:
+            str: Filepath to downloaded file.
+       """
+        if platform_name is None:
+            platform_name = platform.system().lower()
+
+        package_filepath = os.path.join(dst_directory, filename)
+        self.download_file(
+            "dependencies/{}/{}".format(package_name, platform_name),
+            package_filepath,
+            chunk_size=chunk_size,
+            progress=progress
+        )
+        return package_filepath
+
+    def upload_dependency_package(
+        self, filepath, package_name, platform_name=None, progress=None
+    ):
+        if platform_name is None:
+            platform_name = platform.system().lower()
+
+        self.upload_file(
+            "dependencies/{}/{}".format(package_name, platform_name),
+            filepath,
+            progress=progress
+        )
+
+    def delete_dependency_package(self, package_name, platform_name=None):
+        if platform_name is None:
+            platform_name = platform.system().lower()
+
+        response = self.delete(
+            "dependencies/{}/{}".format(package_name, platform_name),
+        )
+        if response.status != 200:
+            raise ServerError("Failed to delete dependency file")
+        return response.data
+
     # Anatomy presets
     def get_project_anatomy_presets(self, add_default=True):
         result = self.get("anatomy/presets")
@@ -713,13 +1102,32 @@ class ServerAPIBase(object):
             return full_settings
         return full_settings["settings"]
 
-    def get_addon_settings(self, addon_name, addon_version, project_name):
+    def get_addon_studio_settings(self, addon_name, addon_version):
+        result = self.get(
+            "addons/{}/{}/settings".format(addon_name, addon_version)
+        )
+        if result.status != 200:
+            raise ServerError(result.text)
+        return result.data
+
+    def get_addon_project_settings(
+        self, addon_name, addon_version, project_name
+    ):
         result = self.get(
             "addons/{}/{}/settings/{}".format(
-                addon_name, addon_version, project_name))
-        if result.status == 200:
-            return result.data
-        return None
+                addon_name, addon_version, project_name
+            )
+        )
+        if result.status != 200:
+            raise ServerError(result.text)
+        return result.data
+
+    def get_addon_settings(self, addon_name, addon_version, project_name=None):
+        if project_name is None:
+            return self.get_addon_studio_settings(addon_name, addon_version)
+        return self.get_addon_project_settings(
+            addon_name, addon_version, project_name
+        )
 
     # Entity getters
     def get_rest_project(self, project_name):
@@ -1864,6 +2272,7 @@ class ServerAPIBase(object):
             version_ids=[version_id],
             active=None,
             fields=fields,
+            own_attributes=own_attributes
         )
         for representation in representations:
             return representation
@@ -1919,7 +2328,7 @@ class ServerAPIBase(object):
         fields=None,
         own_attributes=False
     ):
-        filters = {}
+        filters = {"projectName": project_name}
         if task_ids is not None:
             task_ids = set(task_ids)
             if not task_ids:
@@ -1944,7 +2353,7 @@ class ServerAPIBase(object):
         if own_attributes:
             fields.add("ownAttrib")
 
-        query = workfiles_info_graphql_query()
+        query = workfiles_info_graphql_query(fields)
 
         for attr, filter_value in filters.items():
             query.set_variable_value(attr, filter_value)

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

@@ -85,6 +85,41 @@ def get_server_api_connection():
     return GlobalContext.get_server_api_connection()
 
 
+def get_base_url():
+    con = get_server_api_connection()
+    return con.get_base_url()
+
+
+def get_rest_url():
+    con = get_server_api_connection()
+    return con.get_rest_url()
+
+
+def raw_get(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.raw_get(*args, **kwargs)
+
+
+def raw_post(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.raw_post(*args, **kwargs)
+
+
+def raw_put(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.raw_put(*args, **kwargs)
+
+
+def raw_patch(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.raw_patch(*args, **kwargs)
+
+
+def raw_delete(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.raw_delete(*args, **kwargs)
+
+
 def get(*args, **kwargs):
     con = get_server_api_connection()
     return con.get(*args, **kwargs)
@@ -110,6 +145,106 @@ def delete(*args, **kwargs):
     return con.delete(*args, **kwargs)
 
 
+def download_file(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.download_file(*args, **kwargs)
+
+
+def upload_file(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.upload_file(*args, **kwargs)
+
+
+def query_graphql(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.query_graphql(*args, **kwargs)
+
+
+def get_users(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_users(*args, **kwargs)
+
+
+def get_user(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_user(*args, **kwargs)
+
+
+def get_attributes_for_type(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_attributes_for_type(*args, **kwargs)
+
+
+def get_addons_info(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_addons_info(*args, **kwargs)
+
+
+def download_addon_private_file(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.download_addon_private_file(*args, **kwargs)
+
+
+def get_dependencies_info(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_dependencies_info(*args, **kwargs)
+
+
+def update_dependency_info(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.update_dependency_info(*args, **kwargs)
+
+
+def download_dependency_package(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.download_dependency_package(*args, **kwargs)
+
+
+def upload_dependency_package(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.upload_dependency_package(*args, **kwargs)
+
+
+def delete_dependency_package(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.delete_dependency_package(*args, **kwargs)
+
+
+def get_project_anatomy_presets(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_project_anatomy_presets(*args, **kwargs)
+
+
+def get_project_anatomy_preset(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_project_anatomy_preset(*args, **kwargs)
+
+
+def get_full_production_settings(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_full_production_settings(*args, **kwargs)
+
+
+def get_production_settings(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_production_settings(*args, **kwargs)
+
+
+def get_full_project_settings(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_full_project_settings(*args, **kwargs)
+
+
+def get_project_settings(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_project_settings(*args, **kwargs)
+
+
+def get_addon_settings(*args, **kwargs):
+    con = get_server_api_connection()
+    return con.get_addon_settings(*args, **kwargs)
+
+
 def get_project(*args, **kwargs):
     con = get_server_api_connection()
     return con.get_project(*args, **kwargs)
@@ -245,16 +380,6 @@ def get_representations_parents(*args, **kwargs):
     return con.get_representations_parents(*args, **kwargs)
 
 
-def get_project_settings(*args, **kwargs):
-    con = get_server_api_connection()
-    return con.get_project_settings(*args, **kwargs)
-
-
-def get_addon_settings(*args, **kwargs):
-    con = get_server_api_connection()
-    return con.get_addon_settings(*args, **kwargs)
-
-
 def create_project(
     project_name,
     project_code,

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

@@ -265,3 +265,102 @@ def validate_url(url):
         title="Couldn't connect to server",
         hints=hints + universal_hints
     )
+
+
+class TransferProgress:
+    """Object to store progress of download/upload from/to server."""
+
+    def __init__(self):
+        self._started = False
+        self._done = False
+        self._downloaded = 0
+        self._content_size = None
+
+        self._failed = False
+        self._fail_reason = None
+
+        self._source_url = "N/A"
+        self._destination_url = "N/A"
+
+    def get_content_size(self):
+        return self._content_size
+
+    def set_content_size(self, content_size):
+        if self._content_size is not None:
+            raise ValueError("Content size was set more then once")
+        self._content_size = content_size
+
+    def get_started(self):
+        return self._started
+
+    def set_started(self):
+        if self._started:
+            raise ValueError("Progress already started")
+        self._started = True
+
+    def get_done(self):
+        return self._done
+
+    def set_done(self):
+        if self._done:
+            raise ValueError("Progress was already marked as done")
+        if not self._started:
+            raise ValueError("Progress didn't start yet")
+        self._done = True
+
+    def get_failed(self):
+        return self._failed
+
+    def get_fail_reason(self):
+        return self._fail_reason
+
+    def set_failed(self, reason):
+        self._fail_reason = reason
+        self._failed = True
+
+    def get_downloaded_size(self):
+        return self._downloaded
+
+    def set_downloaded_size(self, downloaded_size):
+        self._downloaded = downloaded_size
+
+    def add_downloaded_chunk(self, chunk_size):
+        self._downloaded += chunk_size
+
+    def get_source_url(self):
+        return self._source_url
+
+    def set_source_url(self, url):
+        self._source_url = url
+
+    def get_destination_url(self):
+        return self._destination_url
+
+    def set_destination_url(self, url):
+        self._destination_url = url
+
+    @property
+    def is_running(self):
+        if (
+            not self.started
+            or self.done
+            or self.failed
+        ):
+            return False
+        return True
+
+    @property
+    def progress(self):
+        if self._content_size is None:
+            return None
+        return (self._downloaded * 100.0) / float(self._content_size)
+
+    content_size = property(get_content_size, set_content_size)
+    started = property(get_started)
+    done = property(get_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)

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

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

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

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

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ayon_api"
-version = "0.1.4"
+version = "0.1.7"
 description = "Python api for AYON server"
 authors = ["ynput.io <info@ynput.io>"]
 

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

@@ -34,5 +34,5 @@ setup(
     dependency_links=[
         "appdirs @ git+https://github.com/ActiveState/appdirs.git@master"
     ],
-    keywords=["AYON", "ynput", "OpenPype", "vfx"]
+    keywords=["AYON", "ynput", "OpenPype", "vfx"],
 )