everysk-lib 1.10.2__cp312-cp312-win_amd64.whl

everysk/api/api_resources/tests.py

@@ -0,0 +1,115 @@
+###############################################################################
+#
+# (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.
+#
+###############################################################################
+# pylint: disable=unused-import
+
+###########################################
+# API RESOURCE
+###########################################
+from everysk.api.api_resources._tests.api_resource import APIResourceTestCase as EveryskLibAPIResourceTestCase
+
+###########################################
+# FILE
+###########################################
+from everysk.api.api_resources._tests.file import APIFileTestCase as EveryskLibAPIFileTestCase
+
+###########################################
+# CUSTOM INDEX
+###########################################
+from everysk.api.api_resources._tests.custom_index import APICustomIndexTestCase as EveryskLibAPICustomIndexTestCase
+
+###########################################
+# PRIVATE SECURITY
+###########################################
+from everysk.api.api_resources._tests.private_security import APIPrivateSecurityTestCase as EveryskLibAPIPrivateSecurityTestCase
+
+###########################################
+# WORKSPACE
+###########################################
+from everysk.api.api_resources._tests.workspace import APIWorkspaceTestCase as EveryskLibAPIWorkspaceTestCase
+
+###########################################
+# REPORT TEMPLATE
+###########################################
+from everysk.api.api_resources._tests.report_template import APIReportTemplateTestCase as EveryskLibAPIReportTemplateTestCase
+
+###########################################
+# PORTFOLIO
+###########################################
+from everysk.api.api_resources._tests.portfolio import APIPortfolioTestCase as EveryskLibAPIPortfolioTestCase
+
+###########################################
+# DATASTORE
+###########################################
+from everysk.api.api_resources._tests.datastore import APIDatastoreTestCase as EveryskLibAPIDatastoreTestCase
+
+###########################################
+# WORKER EXECUTION
+###########################################
+from everysk.api.api_resources._tests.worker_execution import APIWorkerExecutionTestCase as EveryskLibAPIWorkerExecutionTestCase
+
+###########################################
+# PARSER
+###########################################
+from everysk.api.api_resources._tests.parser import APIParserTestCase as EveryskLibAPIParserTestCase
+
+###########################################
+# WORKFLOW EXECUTION
+###########################################
+from everysk.api.api_resources._tests.workflow_execution import APIWorkflowExecutionTestCase as EveryskLibAPIWorkflowExecutionTestCase
+
+###########################################
+# WORKFLOW
+###########################################
+from everysk.api.api_resources._tests.workflow import APIWorkflowTestCase as EveryskLibAPIWorkflowTestCase
+
+###########################################
+# CALCULATION
+###########################################
+from everysk.api.api_resources._tests.calculation import APICalculationTestCase as EveryskLibAPICalculationTestCase
+
+###########################################
+# MARKET DATA
+###########################################
+from everysk.api.api_resources._tests.market_data import APIMarketDataTestCase as EveryskLibAPIMarketDataTestCase
+
+###########################################
+# REPORT
+###########################################
+from everysk.api.api_resources._tests.report import APIReportTestCase as EveryskLibAPIReportTestCase
+
+###########################################
+# RETRIEVABLE API
+###########################################
+from everysk.api.api_resources._tests.api_resource import RetrievableAPIResourceTestCase as EveryskLibRetrievableAPIResourceTestCase
+
+###########################################
+# LISTABLE API
+###########################################
+from everysk.api.api_resources._tests.api_resource import ListableAPIResourceTestCase as EveryskLibListableAPIResourceTestCase
+
+###########################################
+# CREATABLE API
+###########################################
+from everysk.api.api_resources._tests.api_resource import CreatableAPIResourceTestCase as EveryskLibCreatableAPIResourceTestCase
+
+###########################################
+# FILTERABLE API
+###########################################
+from everysk.api.api_resources._tests.api_resource import FilterableAPIResourceTestCase as EveryskLibFilterableAPIResourceTestCase
+
+###########################################
+# UPDATABLE API
+###########################################
+from everysk.api.api_resources._tests.api_resource import UpdatableAPIResourceTestCase as EveryskLibUpdatableAPIResourceTestCase
+
+###########################################
+# DELETABLE API
+###########################################
+from everysk.api.api_resources._tests.api_resource import DeletableAPIResourceTestCase as EveryskLibDeletableAPIResourceTestCase

everysk/api/api_resources/worker_execution.py

@@ -0,0 +1,64 @@
+###############################################################################
+#
+# (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.api_resources.api_resource import (
+    RetrievableAPIResource,
+    ListableAPIResource,
+    DeletableAPIResource
+)
+from everysk.api import utils
+
+###############################################################################
+#   Worker Execution Implementation
+###############################################################################
+class WorkerExecution(
+    RetrievableAPIResource,
+    ListableAPIResource,
+    DeletableAPIResource
+):
+
+    @classmethod
+    def retrieve(cls, **kwargs):
+        """
+        Retrieves details of a single worker execution or a list of worker executions based on the provided arguments.
+        This class method sends a GET request to the API to retrieve a worker execution.
+
+        Args:
+            worker_execution_id (str, optional):
+                The ID of the worker execution to retrieve. If specified, the method
+                returns details for this specific worker execution. If omitted, the
+                method may return a list of worker executions based on other filters.
+
+            workflow_execution_id (str, optional):
+                The ID of the workflow execution to fetch the worker executions for.
+                This argument is considered only if 'worker_execution_id' is not provided.
+
+            with_result (bool, optional):
+                Indicates whether to include detailed results in the response. The default
+                behavior depends on the context of the request (detailed for a single execution,
+                summary for a list).
+
+        Returns:
+            WorkerExecution: An instance of the WorkerExecution class
+
+        Example:
+            # Retrieve details for a specific worker execution
+            >>> worker_execution = WorkerExecution.retrieve(worker_execution_id='12345')
+
+            # Retrieve a list of worker executions for a specific workflow execution
+            >>> worker_executions = WorkerExecution.retrieve(workflow_execution_id='67890')
+        """
+        api_req = utils.create_api_requestor(kwargs)
+        url = f'/workflows{cls.class_url()}'
+        response = api_req.get(url, kwargs)
+        return utils.to_object(WorkerExecution, kwargs, response)

everysk/api/api_resources/workflow.py

@@ -0,0 +1,65 @@
+###############################################################################
+#
+# (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.api_resources.api_resource import (
+    RetrievableAPIResource,
+    ListableAPIResource,
+    DeletableAPIResource,
+    CreateableAPIResource,
+    UpdateableAPIResource
+)
+from everysk.api.api_resources.workflow_execution import WorkflowExecution
+from everysk.api import utils
+
+###############################################################################
+#   Workflow Implementation
+###############################################################################
+class Workflow(
+    RetrievableAPIResource,
+    ListableAPIResource,
+    DeletableAPIResource,
+    CreateableAPIResource,
+    UpdateableAPIResource
+):
+
+    @classmethod
+    def run(cls, id, **kwargs):
+        """
+        Executes a workflow based on the provided ID, and any additional keyword arguments provided.
+        This method constructs an API request to trigger the execution of a specific workflow. It uses the
+        `create_api_requestor` function to establish API communication, constructs the appropriate URL,
+        and sends a POST request to initiate the workflow execution.
+
+        Args:
+            id (str):
+                The identifier of the workflow to be executed.
+
+            **kwargs:
+                Additional keyword arguments passed for the API request customization.
+
+        Returns:
+            WorkflowExecution: An instance of WorkflowExecution
+
+        Example:
+            >>> from everysk.api.api_resources.workflow import Workflow
+            >>> response = Workflow.run('12345', param1='value1', param2='value2')
+            >>> print(response)
+        """
+        api_req = utils.create_api_requestor(kwargs)
+        url = f'{cls.class_url()}/{id}/run'
+        response = api_req.post(url, kwargs)
+        extra_keys = None
+
+        if kwargs.get('synchronous', None):
+            extra_keys = ['result']
+        return utils.to_object(WorkflowExecution, kwargs, response, extra_keys=extra_keys)

everysk/api/api_resources/workflow_execution.py

@@ -0,0 +1,93 @@
+###############################################################################
+#
+# (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.api_resources.api_resource import (
+    RetrievableAPIResource,
+    ListableAPIResource,
+    DeletableAPIResource
+)
+from everysk.api import utils
+from .worker_execution import WorkerExecution
+
+###############################################################################
+#   Workflow Execution Implementation
+###############################################################################
+class WorkflowExecution(
+    RetrievableAPIResource,
+    ListableAPIResource,
+    DeletableAPIResource
+):
+
+    @classmethod
+    def retrieve(cls, workflow_id, **kwargs):
+        """
+        Retrieves a single workflow execution or a paginated list of workflow executions associated with a given workflow ID.
+        When a specific workflow execution ID is provided, details for that execution are returned. Without an execution ID,
+        the method returns a paginated list of all executions for the workflow.
+        If `workflow_execution_id` is not provided, pagination parameters (`page_size` and `page_token`) can be used to
+        navigate through a potentially large set of workflow executions.
+
+        Args:
+            workflow_id (str):
+                The unique identifier of the workflow for which executions are being retrieved.
+
+            workflow_execution_id (str, optional):
+                The specific workflow execution ID to retrieve. If provided, the method
+                returns information for this execution only.
+
+            page_size (int, optional):
+                The number of items to return in a single page (applicable when retrieving a list
+                of workflow executions).
+
+            page_token (str, optional):
+                The token for the next page of results (applicable when retrieving a list of
+                workflow executions).
+
+        Returns:
+            WorkflowExecution or list: If a `workflow_execution_id` is provided, returns a `WorkflowExecution` object for that ID.
+            Otherwise, returns a list of `WorkflowExecution` objects for the specified workflow ID,
+            potentially paginated.
+        """
+        api_req = utils.create_api_requestor(kwargs)
+        url = f'/workflows/{workflow_id}{cls.class_url()}'
+        response = api_req.get(url, kwargs)
+        return utils.to_object(WorkflowExecution, kwargs, response)
+
+    @classmethod
+    def syncronous_retrieve(cls, workflow_id, **kwargs):
+        """
+        Retrieves a workflow execution synchronously.
+        This class method retrieves a workflow execution synchronously, continuously polling the API until the execution is completed.
+
+        Args:
+            workflow_id (str):
+                The unique identifier of the workflow for which the execution is being retrieved.
+
+            **kwargs:
+                Additional keyword arguments passed to the `retrieve` method. These can include parameters like
+                `workflow_execution_id` to specify the exact execution to poll, or pagination parameters (`page_size`,
+                `page_token`) when expecting a list of executions.
+
+        Returns:
+            An instance of `WorkerExecution` containing the details of the ender worker execution of the completed workflow, including execution results.
+        """
+        workflow_execution = None
+        status = None
+
+        while status != 'COMPLETED':
+            workflow_execution = cls.retrieve(workflow_id, **kwargs)
+            status = workflow_execution['status']
+            utils.sleep(1)
+
+        worker_execution_id = workflow_execution['ender_worker_execution_id']
+        return WorkerExecution.retrieve(worker_execution_id=worker_execution_id, with_result=True)

everysk/api/api_resources/workspace.py

@@ -0,0 +1,42 @@
+###############################################################################
+#
+# (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.api_resources.api_resource import (
+    RetrievableAPIResource,
+    ListableAPIResource,
+    DeletableAPIResource,
+    CreateableAPIResource,
+    UpdateableAPIResource
+)
+
+###############################################################################
+#   Workspace Implementation
+###############################################################################
+class Workspace(
+    RetrievableAPIResource,
+    ListableAPIResource,
+    DeletableAPIResource,
+    CreateableAPIResource,
+    UpdateableAPIResource
+):
+    """
+    Represents a workspace object
+
+    Args:
+        RetrievableAPIResource (_type_): _description_
+        ListableAPIResource (_type_): _description_
+        DeletableAPIResource (_type_): _description_
+        CreateableAPIResource (_type_): _description_
+        UpdateableAPIResource (_type_): _description_
+    """
+    pass

everysk/api/http_client.py

@@ -0,0 +1,63 @@
+###############################################################################
+#
+# (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 requests
+from requests.packages.urllib3.exceptions import InsecureRequestWarning  # pylint: disable=import-error
+
+from everysk.core.datetime.date_settings import DEFAULT_DATE_FORMAT, DEFAULT_DATE_TIME_FORMAT
+from everysk.core.serialize import dumps
+
+requests.packages.urllib3.disable_warnings(InsecureRequestWarning)  # pylint: disable=no-member
+
+
+###############################################################################
+#   HTTPClient Implementation
+###############################################################################
+class HTTPClient:
+    def __init__(self, timeout=3600, verify_ssl_certs=True, allow_redirects=False) -> None:
+        self.timeout = timeout
+        self.allow_redirects = allow_redirects
+        self.verify_ssl_certs = verify_ssl_certs
+
+    def request(self, method, url, headers, params=None, payload=None):
+        raise NotImplementedError('HTTPClient subclasses must implement `request`.')
+
+
+###############################################################################
+#   Requests Client Implementation
+###############################################################################
+class RequestsClient(HTTPClient):
+    def request(self, method, url, headers, params=None, payload=None):
+        _args = {
+            'method': method,
+            'url': url,
+            'headers': headers,
+            'params': params,
+            'timeout': self.timeout,
+            'verify': self.verify_ssl_certs,
+            'allow_redirects': self.allow_redirects,
+        }
+
+        if payload:
+            _args['data'] = dumps(
+                payload,
+                date_format=DEFAULT_DATE_FORMAT,
+                datetime_format=DEFAULT_DATE_TIME_FORMAT,
+                use_undefined=False,
+                add_class_path=False,
+                decode_bytes=True,
+            )
+
+        response = requests.request(**_args)
+
+        return (response.status_code, response.content)
+
+
+def new_default_http_client(*args, **kwargs):
+    return RequestsClient(*args, **kwargs)

everysk/api/tests.py

@@ -0,0 +1,32 @@
+###############################################################################
+#
+# (C) Copyright 2023 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.
+#
+###############################################################################
+# pylint: disable=unused-import, wildcard-import, unused-wildcard-import
+
+###############################################################################
+#   Imports
+###############################################################################
+from everysk.api.api_resources.tests import *
+
+from everysk.api._tests.api_requestor import APIRequestorTestCase as EveryskLibAPIRequestorTestCase
+
+from everysk.api._tests.http_client import (
+    HTTPClientTestCase as EveryskLibHTTPClientTestCase,
+    RequestsClientTestCase as EveryskLibRequestsClientTestCase,
+    StandardHTTPClientTestCase as EveryskLibStandardHTTPClientTestCase
+)
+
+from everysk.api._tests.init import TestGetAPIConfig as EveryskLibTestGetAPIConfig
+
+from everysk.api._tests.utils import (
+    EveryskObjectTestCase as EveryskLibEveryskObjectTestCase,
+    EveryskListTestCase as EveryskLibEveryskListTestCase,
+    UtilsTestCase as EveryskLibUtilsTestCase
+
+)