everysk-lib 1.10.2__cp312-cp312-win_amd64.whl

everysk/api/__init__.py

@@ -0,0 +1,61 @@
+###############################################################################
+#
+# (C) Copyright 2025 EVERYSK TECHNOLOGIES
+#
+# This is an unpublished work containing confidential and proprietary
+# information of EVERYSK TECHNOLOGIES. Disclosure, use, or reproduction
+# without authorization of EVERYSK TECHNOLOGIES is prohibited.
+#
+###############################################################################
+from everysk.config import settings
+
+def get_api_config(params) -> tuple:
+    """
+    Retrieve API configuration settings from the give parameters or environment variables
+
+    This function checks if the arguments `api_entry`, `api_version`, `api_sid`, `api_token`, and `verify_ssl_certs` are provided in the `params` dictionary.
+    If not, it attempts to retrieve them from global variables or environment variables.
+
+    Args:
+        params (dict): A dictionary containing the API configuration settings
+
+    Returns:
+        tuple: A tuple containing the API entry point, version, session ID, token, and SSL certificate.
+
+    Example:
+        >>> data = {
+        >>> ...     'api_entry': 'https://example.com',
+        >>> ...     'api_version': 'v2',
+        >>> ...     'api_sid': 'abc',
+        >>> ...     'api_token': 'token_example123',
+        >>> ...     'verify_ssl_certs': True
+        >>> }
+
+        >>> config = get_api_config(data)
+        >>> print(config)
+        ('https://example.com', 'v2', 'abc', 'token_example123', True)
+    """
+    api_entry = params.get('api_entry', None)
+    if api_entry is None:
+        api_entry = settings.EVERYSK_API_URL
+
+    api_version = params.get('api_version', None)
+    if api_version is None:
+        api_version = settings.EVERYSK_API_VERSION
+
+    api_sid = params.get('api_sid', None)
+    if api_sid is None:
+        api_sid = settings.EVERYSK_API_SID
+
+    api_token = params.get('api_token', None)
+    if api_token is None:
+        api_token = settings.EVERYSK_API_TOKEN
+
+    verify_ssl_certs = params.get('verify_ssl_certs', None)
+    if verify_ssl_certs is None:
+        verify_ssl_certs = settings.EVERYSK_API_VERIFY_SSL_CERTS
+
+    return (api_entry, api_version, api_sid, api_token, verify_ssl_certs)
+
+from everysk.utils import *
+from everysk.api.api_resources import *

everysk/api/api_requestor.py

@@ -0,0 +1,167 @@
+###############################################################################
+#
+# (C) Copyright 2025 EVERYSK TECHNOLOGIES
+#
+# This is an unpublished work containing confidential and proprietary
+# information of EVERYSK TECHNOLOGIES. Disclosure, use, or reproduction
+# without authorization of EVERYSK TECHNOLOGIES is prohibited.
+#
+###############################################################################
+import json
+
+from typing import Any
+
+from everysk.config import settings
+from everysk.api import http_client
+from everysk.core.exceptions import APIError
+
+###############################################################################
+#   APIRequestor Implementation
+###############################################################################
+class APIRequestor(object):
+
+    def __init__(self, api_entry, api_version, api_sid, api_token, verify_ssl_certs) -> None:
+        """
+        Initializes an APIRequestor object with the necessary parameters to make HTTP requests to an API.
+
+        This constructors sets up the APIRequestor with custom headers, including authorization, content type and user agent details.
+
+        Args:
+            api_entry (str): The base URL of the API endpoint.
+            api_version (str): The current version of the API.
+            api_sid (str): The API SID (identifier) for authentication.
+            api_token (str): The API token for authentication.
+            verify_ssl_certs (bool): Specified whether SSL certificates should be verified.
+
+        Raises:
+            Exception: If any of the parameters are invalid.
+
+        Example:
+            >>> from everysk.api.api_requestor import APIRequestor
+
+            >>> api_requestor = APIRequestor(
+            >>> ... api_entry='https://api.example.com',
+            >>> ... api_version='v2',
+            >>> ... api_sid='your_api_sid',
+            >>> ... api_token='your_api_token',
+            >>> ... verify_ssl_certs=True
+            >>> ... )
+        """
+        if not api_entry:
+            raise ValueError('Empty api_entry.') # pylint: disable=broad-exception-raised
+        if api_version != 'v2':
+            raise ValueError('Invalid api_version (supported version: "v2").') # pylint: disable=broad-exception-raised
+        if not api_sid:
+            raise ValueError('Invalid api_sid.') # pylint: disable=broad-exception-raised
+        if not api_token:
+            raise ValueError('Invalid api_token.') # pylint: disable=broad-exception-raised
+
+        self.headers = settings.HTTP_DEFAULT_HEADERS.copy()
+        self.headers.update(
+            {
+                'Content-Type': 'application/json',
+                'Authorization': f'Bearer {api_sid}:{api_token}',
+                'User-Agent': f'Everysk PythonBindings/{api_version}'
+            }
+        )
+        self.base_url = f'{api_entry}/{api_version}'
+        self.client = http_client.new_default_http_client(
+            timeout=3600,
+            verify_ssl_certs=verify_ssl_certs,
+            allow_redirects=False
+        )
+
+    def _clean_response(self, code: int, response: str) -> Any:
+        if code not in settings.HTTP_SUCCESS_STATUS_CODES:
+            raise APIError(code, response)
+        return json.loads(response)
+
+    def get(self, path, params):
+        """
+        Sends a GET request to the specified path with the given parameters.
+
+        Args:
+            path (str): The path to send the GET request to.
+            params (dict): The parameters to include in the GET request.
+
+        Returns:
+            dict: The JSON response from the GET request.
+
+        Raises:
+            APIError: If the response code is not in the HTTP_SUCCESS_STATUS_CODES list.
+        """
+        url = f'{self.base_url}{path}'
+        code, response = self.client.request(
+            'GET',
+            url,
+            headers=self.headers,
+            params=params
+        )
+        return self._clean_response(code, response)
+
+    def post(self, path, payload):
+        """
+        Sends a POST request to the specified path with the given payload.
+
+        Args:
+            path (str): The path to send the request to.
+            payload (dict): The payload to include in the request.
+
+        Raises:
+            APIError: If the response code is not in the HTTP_SUCCESS_STATUS_CODES list.
+
+        Returns:
+            dict: The JSON response from the API.
+        """
+        url = f'{self.base_url}{path}'
+        code, response = self.client.request(
+            'POST',
+            url,
+            headers=self.headers,
+            payload=payload
+        )
+        return self._clean_response(code, response)
+
+    def delete(self, path):
+        """
+        Sends a DELETE request to the specified path.
+
+        Args:
+            path (str): The path to send the DELETE request to.
+
+        Raises:
+            APIError: If the response code is not in the HTTP_SUCCESS_STATUS_CODES list.
+
+        Returns:
+            dict: The JSON response from the server.
+        """
+        url = f'{self.base_url}{path}'
+        code, response = self.client.request(
+            'DELETE',
+            url,
+            headers=self.headers
+        )
+        return self._clean_response(code, response)
+
+    def put(self, path, payload):
+        """
+        Sends a PUT request to the specified path with the given payload.
+
+        Args:
+            path (str): The path to send the request to.
+            payload (dict): The payload to include in the request.
+
+        Raises:
+            APIError: If the response code is not in the HTTP_SUCCESS_STATUS_CODES list.
+
+        Returns:
+            dict: The JSON response from the server.
+        """
+        url = f'{self.base_url}{path}'
+        code, response = self.client.request(
+            'PUT',
+            url,
+            headers=self.headers,
+            payload=payload
+        )
+        return self._clean_response(code, response)

everysk/api/api_resources/__init__.py

@@ -0,0 +1,23 @@
+###############################################################################
+#
+# (C) Copyright 2025 EVERYSK TECHNOLOGIES
+#
+# This is an unpublished work containing confidential and proprietary
+# information of EVERYSK TECHNOLOGIES. Disclosure, use, or reproduction
+# without authorization of EVERYSK TECHNOLOGIES is prohibited.
+#
+###############################################################################
+from everysk.api.api_resources.workspace import Workspace
+from everysk.api.api_resources.workflow import Workflow
+from everysk.api.api_resources.workflow_execution import WorkflowExecution
+from everysk.api.api_resources.worker_execution import WorkerExecution
+from everysk.api.api_resources.portfolio import Portfolio
+from everysk.api.api_resources.report import Report
+from everysk.api.api_resources.report_template import ReportTemplate
+from everysk.api.api_resources.datastore import Datastore
+from everysk.api.api_resources.file import File
+from everysk.api.api_resources.custom_index import CustomIndex
+from everysk.api.api_resources.private_security import PrivateSecurity
+from everysk.api.api_resources.calculation import Calculation
+from everysk.api.api_resources.market_data import MarketData
+from everysk.api.api_resources.parser import Parser

everysk/api/api_resources/api_resource.py

@@ -0,0 +1,371 @@
+###############################################################################
+#
+# (C) Copyright 2025 EVERYSK TECHNOLOGIES
+#
+# This is an unpublished work containing confidential and proprietary
+# information of EVERYSK TECHNOLOGIES. Disclosure, use, or reproduction
+# without authorization of EVERYSK TECHNOLOGIES is prohibited.
+#
+###############################################################################
+
+###############################################################################
+#   Imports
+###############################################################################
+from everysk.api import utils
+from everysk.core.string import pluralize, snake_case
+
+###############################################################################
+#   APIResource Implementation
+###############################################################################
+class APIResource(utils.EveryskObject):
+    """
+    Represents a resource accessible via an API
+
+    This class serves as a base class for API resources and provides method for refreshing resource data and obtaining class names and URLs.
+    """
+    def __init__(self, retrieve_params, params) -> None:
+        super().__init__(retrieve_params, params)
+        self.__retrieve_params = retrieve_params
+
+    def refresh(self, **kwargs):
+        """
+        Refreshes the resource data from the API.
+
+        Args:
+            **kwargs: Additional keyword arguments.
+
+        Returns:
+            APIResource: The refreshed APIResource object.
+        """
+        api_req = utils.create_api_requestor(kwargs)
+        url = f"{self.class_url()}/{self.get('id')}"
+        response = api_req.get(url, self.__retrieve_params)
+        data = response[self.class_name()]
+        self.update(data)
+        self.clear_unsaved_values()
+        return self
+
+    @classmethod
+    def class_name(cls):
+        """
+        convert the class name to the snake case format
+        """
+        return snake_case(cls.__name__)
+
+    @classmethod
+    def class_name_list(cls):
+        """
+        Returns the pluralized class name.
+
+        Returns:
+            str: The pluralized class name.
+        """
+        return pluralize(cls.class_name())
+
+    @classmethod
+    def class_url(cls):
+        """
+        Returns the URL path for the class.
+        Utilizing the class name list and ensuring consistency across different parts of the code.
+
+        Returns:
+            str: The URL path for the class.
+        """
+        return f'/{cls.class_name_list()}'
+
+###############################################################################
+#   Retrievable APIResource Implementation
+###############################################################################
+class RetrievableAPIResource(APIResource):
+
+    @classmethod
+    def retrieve(cls, id, **kwargs):
+        """
+        Retrieves a single resource from the API by its ID.
+        Sends a GET request to the API to retrieve a single resource of the specified class type
+        identified by the provided ID.
+
+        Args:
+            id (str):
+                The unique identifier of the resource.
+
+            workspace (str):
+                Determines on which workspace the request will be made
+
+            **kwargs (dict):
+                Any additional keyword arguments to customize the request
+
+        Returns:
+            object: A single resource of the class type.
+        """
+        api_req = utils.create_api_requestor(kwargs)
+        url = f'{cls.class_url()}/{id}'
+        response = api_req.get(url, kwargs)
+        return utils.to_object(cls, kwargs, response)
+
+###############################################################################
+#   Listable APIResource Implementation
+###############################################################################
+class ListableAPIResource(APIResource):
+
+    @classmethod
+    def list(cls, **kwargs):
+        """
+        Retrieves a list of resources from the API.
+        This class method sends a GET request to the API to retrieve a list of resources of the specified class type.
+        Check https://everysk.com/api/docs/#list-all-portfolios for additional information
+
+        Args:
+            query (str, optional):
+                Request a list of portfolios fileting it by `name` or `tag`
+
+            workspace (str, optional):
+                Determines on which workspace the request will be made
+
+            page_size (int, optional):
+                Set the number of object that will be listed per page
+
+            page_token (int, optional):
+                This token defines which page will be returned to the user
+
+            **kwargs (dict):
+                Additional keyword arguments to customize the request
+
+        Returns:
+            list: A list of resource of the class type.
+        """
+        api_req = utils.create_api_requestor(kwargs)
+        url = cls.class_url()
+        response = api_req.get(url, kwargs)
+        return utils.to_list(cls, kwargs, response)
+
+    @classmethod
+    def auto_paging_iter(cls, **kwargs):
+        """
+        Provides an iterator over all resources, handling pagination automatically.
+        This class method iterates over all resources of the specified class type, handling pagination automatically
+        to retrieve the complete list of resources. Check https://everysk.com/api/docs/#pagination for more information
+
+        Args:
+            page_size (int):
+                A limit on the number of objects to be returned, between 1 and 100
+
+            page_token (str):
+                Returns the previous page token
+
+            **kwargs (dict):
+                Additional keyword arguments to customize the request, such as filters or pagination parameters.
+
+        Returns:
+            object: A resource of the class type.
+        """
+        params = dict(kwargs)
+        page = cls.list(**params)
+        while True:
+            for item in page:
+                yield item
+            if page.next_page_token() is None:
+                return
+            params['page_token'] = page.next_page_token()
+            page = cls.list(**params)
+
+###############################################################################
+#   Deletable APIResource Implementation
+###############################################################################
+class DeletableAPIResource(APIResource):
+
+    def delete(self):
+        """
+        Deletes the current instance of the resource from the API
+        This class method sends a DELETE request to the API to delete the current instance.
+
+        Example:
+            >>> from everysk.api.api_resources.api_resource import DeletableAPIResource
+            >>> resource = DeletableAPIResource.retrieve("resource_id")
+            >>> resource.delete()
+        """
+        api_req = utils.create_api_requestor()
+        url = f"{self.class_url()}/{self.get('id')}"
+        workspace = self.get('workspace', None)
+        if workspace:
+            url = f'{url}?workspace={workspace}'
+        response = api_req.delete(url)
+        data = response[self.class_name()]
+        self.clear()
+        self.update(data)
+        self.clear_unsaved_values()
+        return self
+
+    @classmethod
+    def remove(cls, id, **kwargs):
+        """
+        Deletes a resource from the API by its ID.
+        Sends a DELETE request to the API to delete a resource of the specified class type
+        identified by the provided ID.
+
+        Args:
+            id: The unique identifier of the resource to be deleted.
+
+            workspace (str, optional):
+                Determines on which workspace the request will be made.
+
+            **kwargs (dict): Additional keyword arguments to customize the request.
+
+        Example:
+            >>> DeletableAPIResource.remove('resource_id')
+            Deleted resource_object
+        """
+        api_req = utils.create_api_requestor()
+        url = f'{cls.class_url()}/{id}'
+        workspace = kwargs.get('workspace', None)
+        if workspace:
+            url = f'{url}?workspace={workspace}'
+        response = api_req.delete(url)
+        data = response[cls.class_name()]
+        return utils.to_object(cls, {}, response)
+
+###############################################################################
+#   Creatable APIResource Implementation
+###############################################################################
+class CreateableAPIResource(APIResource):
+
+    @classmethod
+    def create(cls, **kwargs):
+        """
+        Creates a new instance of the resource and saves it to the API.
+        This class method sends a POST request to the API to create a new instance of the resource with the provided data.
+
+        Args:
+            description (str, optional):
+                Provides detailed information about the resource
+
+            tags (list, optional):
+                Sequence of hashtags used to label the related resources. Any sequence of lowercase character, numbers, and underscore might be used.
+
+            date (str, optional):
+                Resource date in the following format: `YYYYMMDD`
+
+            workspace (str, optional):
+                Determines on which workspace the request will be made
+
+            **kwargs (dict):
+                Keyword arguments representing the data for creating the resource. Depending on the resource, each entity will have different kwargs.
+
+        Example:
+            >>> new_resource_data = {'name': 'New Resource'}
+            >>> new_resource = CreatableAPIResource.create(**new_resource_data)
+            >>> print(new_resource)
+            New resource_object
+        """
+        api_req = utils.create_api_requestor(kwargs)
+        url = cls.class_url()
+        response = api_req.post(url, kwargs)
+        return utils.to_object(cls, kwargs, response)
+
+###############################################################################
+#   Updatable APIResource Implementation
+###############################################################################
+class UpdateableAPIResource(APIResource):
+
+    @classmethod
+    def modify(cls, id, **kwargs):
+        """
+        Modifies a resource by its ID with the provided data.
+
+        This class method sends a PUT request to the API to modify a resource of the specified class type
+        identified by the provided ID with the provided data.
+
+        Args:
+            id (str):
+                The unique identifier of the resource to be modified.
+
+            **kwargs (dict):
+                Keyword arguments representing the data to be updated. The kwargs will differ for each entity.
+
+        Example:
+            >>> updated_data = {'name': 'Updated Resource'}
+            >>> updated_resource = UpdateableAPIResource.modify('resource_id', **updated_data)
+            >>> print(updated_resource)
+            Updated resource_object
+        """
+        api_req = utils.create_api_requestor(kwargs)
+        url = f'{cls.class_url()}/{id}'
+        response = api_req.put(url, kwargs)
+        data = response[cls.class_name()]
+        return utils.to_object(cls, kwargs, response)
+
+    def save(self, **kwargs):
+        """
+        Saves the changes made to the current instance of the resource to the API.
+        This method sends a PUT request to the API to save the changes made to the current instance of the resource.
+
+        Args:
+            **kwargs (dict):
+                each entity will have different arguments for saving
+
+        Example:
+            >>> resource = UpdateableAPIResource.retrieve('resource_id')
+            >>> resource['name'] = 'Updated Name'
+            >>> resource.save()
+            Updated resource_object
+        """
+        api_req = utils.create_api_requestor(kwargs)
+        url = f"{self.class_url()}/{self.get('id')}"
+        #response = api_req.put(url, self)
+        unsaved_values = self.get_unsaved_values()
+        response = api_req.put(url, unsaved_values)
+        data = response[self.class_name()]
+        self.update(data)
+        self.clear_unsaved_values()
+        return self
+
+###############################################################################
+#   Filterable APIResource Implementation
+###############################################################################
+class FilterableAPIResource(APIResource):
+
+    @classmethod
+    def filter(cls,**kwargs):
+        """
+        Filters resources based on the provided criteria.
+
+        This class method sends a POST request to the API to filter resources of the specified class type
+        based on the provided criteria.
+
+        Args:
+            limit (int, optional): The maximum number of resources to retrieve. Defaults to a predetermined limit if not specified.
+
+            tags (list[str], optional):
+                A list of strings representing tags used to filter resources. Tags should be a sequence
+                of lowercase characters, numbers, and underscores.
+
+            start (str, optional):
+                A start value used for filtering. The format and usage of this parameter can vary
+                depending on the resource type and should be a string or null.
+
+            end (str, optional):
+                An end value for filtering, similar in format and function to `start`. It should be a string or null.
+
+            date_time (str, optional):
+                A datetime string used for filtering resources. The expected format should be compliant
+                with the API's datetime format requirements.
+
+            link_uid (str, optional):
+                A unique identifier used to filter resources by their association to another entity.
+
+            **kwargs (dict):
+                Additional keyword arguments that represent other filtering criteria not explicitly listed. These should
+                align with the filterable fields of the resources.
+
+        Returns:
+            list: A list of filtered resources.
+
+        Example:
+            >>> filtered_resources = FilterableAPIResource.filter(param1=value1, param2=value2)
+            >>> print(filtered_resources)
+            [filtered_resource1, filtered_resource2, ...]
+        """
+        api_req = utils.create_api_requestor(kwargs)
+        url = f'/{cls.class_name_list()}/filter'
+        response = api_req.post(url, kwargs)
+        return utils.to_list(cls, kwargs, response)