everysk-lib 1.10.2__cp312-cp312-win_amd64.whl

everysk/api/api_resources/custom_index.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
+)
+
+###############################################################################
+#   Custom Index Implementation
+###############################################################################
+class CustomIndex(
+    RetrievableAPIResource,
+    ListableAPIResource,
+    DeletableAPIResource,
+    CreateableAPIResource,
+    UpdateableAPIResource
+):
+    """
+    Represents a custom index resource.
+
+    This class inherits from the following API resources:
+    - RetrievableAPIResource
+    - ListableAPIResource
+    - DeletableAPIResource
+    - CreateableAPIResource
+    - UpdateableAPIResource
+    """
+    pass

everysk/api/api_resources/datastore.py

@@ -0,0 +1,81 @@
+###############################################################################
+#
+# (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,
+    FilterableAPIResource
+)
+from everysk.api import utils
+
+###############################################################################
+#   Datastore Implementation
+###############################################################################
+class Datastore(
+    RetrievableAPIResource,
+    ListableAPIResource,
+    DeletableAPIResource,
+    CreateableAPIResource,
+    UpdateableAPIResource,
+    FilterableAPIResource
+):
+    @classmethod
+    def explore(cls, **kwargs):
+        """
+        Explores the Datastore resource by executing a query with specified parameters to retrieve or manipulate data
+        within a given workspace.
+
+        Args:
+            user_id (int):
+                The ID of the user initiating the request, ensuring that the operation is conducted within
+                the user's context and permissions.
+
+            user_role (str):
+                The role of the user, which may define the access level and capabilities within the explore operation.
+
+            user_time_zone (str):
+                The user's time zone, which can influence how time-based data is retrieved or displayed.
+
+            model (object):
+                The model object or identifier specifying the data or views to be explored within the datastore.
+                This parameter is mandatory and should start with 'view_' if it's a string object.
+
+            overwrites (object, optional):
+                An optional object containing properties to overwrite in the model. This allows
+                for dynamic modifications to the model during the exploration.
+
+            workspace (str):
+                The workspace identifier within which the exploration is to be conducted. This parameter is mandatory
+                and specifies the context or environment for the operation.
+
+        Returns:
+            dict: The response from the API request.
+
+        Example:
+            >>> response = ClassName.explore(
+            >>> ... user_id=12345,
+            >>> ... user_role='analyst',
+            >>> ... user_time_zone='UTC',
+            >>> ... model={'some_model_key': 'some_model_value'},
+            >>> ... overwrites={'key_to_overwrite': 'new_value'},
+            >>> ... workspace='my_workspace'
+            >>> )
+            >>> print(response)
+        """
+        api_req = utils.create_api_requestor(kwargs)
+        url = f'/{cls.class_name_list()}/explore'
+        response = api_req.post(url, kwargs)
+        return response

everysk/api/api_resources/file.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
+)
+
+###############################################################################
+#   File Implementation
+###############################################################################
+class File(
+    RetrievableAPIResource,
+    ListableAPIResource,
+    DeletableAPIResource,
+    CreateableAPIResource,
+    UpdateableAPIResource
+):
+    """
+    Represents a file resource.
+
+    This class inherits from the following API resource classes:
+        - RetrievableAPIResource
+        - ListableAPIResource
+        - DeletableAPIResource
+        - CreateableAPIResource
+        - UpdateableAPIResource
+    """
+    pass

everysk/api/api_resources/market_data.py

@@ -0,0 +1,223 @@
+###############################################################################
+#
+# (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 APIResource
+from everysk.api import utils
+
+###############################################################################
+#   Market Data Implementation
+###############################################################################
+class MarketData(APIResource):
+
+    def refresh(self): # pylint: disable=arguments-differ
+        """
+        Refreshes the current instance of MarketData.
+        """
+        return self
+
+    @classmethod
+    def class_url(cls) -> str:
+        """
+        Returns the class URL in the following format: '/market_data'
+
+        Returns:
+            str: The class url
+
+        Example:
+            >>> from everysk.api.api_resources.market_data import MarketData
+            >>> MarketData.class_url()
+            >>> '/market_data'
+        """
+        return f'/{cls.class_name()}'
+
+    @classmethod
+    def __call_method(cls, method, **kwargs):
+        """
+        A generic function to call various methods on the MarketData object dynamically.
+        It constructs and sends an API request based on the specified method and additional keyword arguments.
+
+        Args:
+            method (str):
+                The name of the method to be called on the MarketData object.
+
+            **kwargs:
+                Variable keyword arguments that are passed to the method being called.
+                These arguments should align with the expected parameters of the target method.
+
+        Returns:
+            response: The response from the API after executing the specified method with the provided arguments.
+        """
+        api_req = utils.create_api_requestor(kwargs)
+        url = f'{cls.class_url()}/{method}'
+        response = api_req.post(url, kwargs)
+        return response
+
+    @classmethod
+    def symbolsSearch(cls, **kwargs):
+        """
+        Searches symbols in MarketData using the user's id to verify permissions and sessions.
+        The function internally calls '__call_method' with 'symbols_search' to perform the actual search operation.
+        The results and their format are dependent on the implementation of the 'symbols_search' method within the MarketData object.
+
+        Args:
+            **kwargs:
+                A dictionary of keyword arguments that should include, but not limited to:
+
+            user_id (str):
+                The ID of the user initiating the symbol search. It is essential for identifying the user's session and permissions.
+
+            user_role (str, optional):
+                The role of the user which may influence the search results based on role-based access controls.
+
+            time_zone (str, optional):
+                The user's time zone, potentially used to adjust the timing information in the search results.
+
+            query (str):
+                The search string used to query the symbol database. This parameter is essential for executing the search and must be provided.
+        """
+        return cls.__call_method('symbols_search', **kwargs)
+
+    @classmethod
+    def symbolsCheck(cls, **kwargs):
+        """
+        This class method checks the validity of market data symbols by invoking the 'symbols_check' method.
+        It validates the symbols against the current market data and potentially other validation criteria.
+        The outcome depends on the implementation of the 'symbols_check' method within the MarketData object.
+
+        Args:
+            **kwargs:
+                A dictionary of keyword arguments that should include:
+
+            securities (list):
+                A list of securities to be checked. Each security should be a dictionary containing at least 'symbol' and optionally 'quantity'.
+
+            date (str, optional):
+                The date for which the securities are to be validated. Defaults to a predefined portfolio date if not specified.
+
+            base_currency (str, optional):
+                The base currency to be used for validation. Defaults to a predefined currency if not specified.
+
+        Returns:
+            dict: The symbols check data
+        """
+        return cls.__call_method('symbols_check', **kwargs)
+
+    @classmethod
+    def symbolsPrice(cls, **kwargs):
+        """
+        Retrieves market prices for specified symbols on a given date using MarketData. This method
+        calls the 'symbols_price' method, passing the user's specifications for symbols and date.
+        The method internally delegates the request to '__call_method' with 'symbols_price' and the provided keyword arguments.
+        Which should align with the expected parameters of the 'symbols_price' method within the MarketData object.
+
+        Args:
+            **kwargs:
+                A dictionary of keyword arguments that should include:
+
+            user_id (str):
+                The ID of the user requesting the price data. Essential for access control and auditing.
+
+            user_role (str):
+                The role of the user which may influence data access permissions.
+
+            time_zone (str):
+                The time zone of the user, possibly affecting the timing and relevancy of the returned data.
+
+            symbols (list):
+                A list of symbol identifiers for which prices are being retrieved. This is a mandatory argument.
+
+            date (str, optional):
+                The specific date for which the price information is requested. Defaults to a pre-defined portfolio date if not provided.
+
+        Returns:
+            dict: The symbols price data.
+        """
+        return cls.__call_method('symbols_price', **kwargs)
+
+    @classmethod
+    def symbolsRealtimePrice(cls, **kwargs):
+        """
+        Retrieves real-time price data for specified symbols using MarketData. This method is
+        a wrapper around the 'symbols_real_time_prices' method, detailing the expected arguments and
+        processing them to fetch real-time prices.
+        This method utilizes '__call_method' to invoke 'symbols_real_time_prices' with the provided keyword arguments
+
+        Args:
+            **kwargs:
+                A dictionary of keyword arguments that should include:
+
+            user_id (str):
+                The ID of the user requesting real-time price data, important for identifying the session and applying data access rules.
+
+            user_role (str):
+                The role of the user, which may affect the scope of data accessible based on permissions.
+
+            time_zone (str):
+                The time zone specification of the user, potentially relevant for time-based data adjustments.
+
+            symbols (list):
+                A list of market data symbols for which real-time prices are requested. This argument is mandatory.
+
+        Returns:
+            dict: The real time price.
+        """
+        return cls.__call_method('symbols_real_time_prices', **kwargs)
+
+    @classmethod
+    def symbolsHistorical(cls, **kwargs):
+        """
+        Retrieves historical data for specified symbols from MarketData. This method interacts
+        with the 'symbols_historical' method, detailing the required arguments to fetch historical
+        price information.
+        The method internally calls '__call_method' with 'symbols_historical' and the provided keyword arguments.
+
+        Args:
+            **kwargs:
+                A dictionary of keyword arguments that should include:
+            user_id (str):
+                The ID of the user requesting historical data, crucial for access control and session identification.
+
+            user_role (str):
+                The role of the user, which can influence the granularity and scope of accessible data.
+
+            time_zone (str):
+                The user's time zone, potentially important for time-aligning the returned data.
+
+            symbols (list):
+                The list of symbols for which historical data is being requested. This is a mandatory field.
+
+            start_date (str, optional):
+                The start date for the historical data retrieval.
+
+            end_date (str, optional):
+                The end date for the historical data query.
+
+            fill_method (str, optional):
+                Method to fill missing data.
+
+            drop_na (bool, optional):
+                Flag to drop or retain missing values.
+
+            with_date_range (bool, optional):
+                Include a complete date range in the response.
+
+            periodicity (str, optional):
+                The granularity of the historical data.
+
+            vendor (str, optional):
+                The data vendor source.
+
+        Returns:
+            dict: The historical data.
+        """
+        return cls.__call_method('symbols_historical', **kwargs)

everysk/api/api_resources/parser.py

@@ -0,0 +1,66 @@
+###############################################################################
+#
+# (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 APIResource
+from everysk.api import utils
+
+###############################################################################
+#   Parser Implementation
+###############################################################################
+class Parser(
+    APIResource
+):
+
+    @classmethod
+    def __call_method(cls, method, **kwargs):
+        """
+        A generic method to call various methods on the Parser object. This function dynamically
+        constructs and executes an API request based on the specified method and additional arguments.
+        It constructs and sends an API request, adapting the URL method and the arguments provided.
+        Since this is a generic function, the callers must ensure that the 'method' argument and the '**kwargs' are appropriate for the specific API function.
+
+        Args:
+            method (str):
+                The name of the method to be called. This method should correspond to a valid API endpoint
+                or a function within the class, determining the nature of the API request to be made.
+
+            **kwargs:
+                A variable set of keyword arguments. These are passed dynamically to the method being called and
+                should align with the expected parameters for that specific method or API endpoint.
+
+        Returns:
+            dict: The API response.
+
+        Example:
+            Assuming there's a method 'fetch_data' that expects parameters 'data_id' and 'filter':
+            >>> response = ClassName.__call_method('fetch_data', data_id=123, filter='typeA')
+            >>> print(response)
+        """
+        api_req = utils.create_api_requestor(kwargs)
+        url = f'{cls.class_url()}/{method}'
+        response = api_req.post(url, kwargs)
+        return response
+
+    @classmethod
+    def parse(cls, method, **kwargs):
+        """
+        Parses data using the specified method.
+
+        Args:
+            method (str): The parsing method.
+            **kwargs: Additional keyword arguments.
+
+        Returns:
+            dict: The parsed data.
+        """
+        return cls.__call_method(f'{method}/parse', **kwargs)

everysk/api/api_resources/portfolio.py

@@ -0,0 +1,43 @@
+###############################################################################
+#
+# (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,
+    FilterableAPIResource
+)
+
+###############################################################################
+#   Portfolio Implementation
+###############################################################################
+class Portfolio(
+    RetrievableAPIResource,
+    ListableAPIResource,
+    DeletableAPIResource,
+    CreateableAPIResource,
+    UpdateableAPIResource,
+    FilterableAPIResource
+):
+    """
+    This class inherits from various API resource classes to provide different operations on the portfolio resource:
+        - RetrievableAPIResource
+        - ListableAPIResource
+        - DeletableAPIResource
+        - CreateableAPIResource
+        - UpdateableAPIResource
+        - FilterableAPIResource
+    """
+    pass

everysk/api/api_resources/private_security.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
+)
+
+###############################################################################
+#   Private Security Implementation
+###############################################################################
+class PrivateSecurity(
+    RetrievableAPIResource,
+    ListableAPIResource,
+    DeletableAPIResource,
+    CreateableAPIResource,
+    UpdateableAPIResource
+):
+    """
+    Represents a private security resource.
+
+    This class inherits from the following API resource classes:
+        - RetrievableAPIResource
+        - ListableAPIResource
+        - DeletableAPIResource
+        - CreateableAPIResource
+        - UpdateableAPIResource
+    """
+    pass

everysk/api/api_resources/report.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,
+    UpdateableAPIResource
+)
+from everysk.api import utils
+
+###############################################################################
+#   Report Implementation
+###############################################################################
+class Report(
+    RetrievableAPIResource,
+    ListableAPIResource,
+    DeletableAPIResource,
+    UpdateableAPIResource
+):
+
+    def share(self, **kwargs):
+        """
+        Shares the current instance of the report by creating a shareable link. This method sends a POST request
+        to the API, setting up the sharing configurations based on the provided arguments.
+
+        Args:
+            expires_after (str, optional):
+                A key representing the time for the shareable link before it expires.
+                Valid keys and their corresponding time values should be predefined and
+                mapped correctly in the 'SHARED_URL_MAX_AGE_MAP'.
+
+            skin_theme (str, optional):
+                A key to determine the theme of the shared report. This should correspond to
+                one of the predefined themes in the 'SKIN_THEME_MAP'.
+
+            **kwargs:
+                Additional keyword arguments that are passed to the API endpoint, allowing further customization
+                of the share operation.
+
+        Returns:
+            Report: The updated report instance.
+
+        Example:
+            >>> report = Report.retrieve('report_id')
+            >>> report.share(user_id='user_id')
+            >>> Shared report_object
+        """
+        api_req = utils.create_api_requestor(kwargs)
+        url = f"{self.class_url()}/{self.get('id')}/share"
+        response = api_req.post(url, kwargs)
+        data = response[self.class_name()]
+        self.update(data)
+        self.clear_unsaved_values()
+        return self

everysk/api/api_resources/report_template.py

@@ -0,0 +1,39 @@
+###############################################################################
+#
+# (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 (
+    DeletableAPIResource,
+    RetrievableAPIResource,
+    ListableAPIResource,
+    UpdateableAPIResource
+)
+
+###############################################################################
+#   Report Template Implementation
+###############################################################################
+class ReportTemplate(
+    RetrievableAPIResource,
+    ListableAPIResource,
+    DeletableAPIResource,
+    UpdateableAPIResource
+):
+    """
+    Represents a report template.
+
+    This class inherits from the following API resource classes:
+    - RetrievableAPIResource
+    - ListableAPIResource
+    - DeletableAPIResource
+    - UpdateableAPIResource
+    """
+    pass