crypticorn 2.4.6__py3-none-any.whl → 2.5.0__py3-none-any.whl

crypticorn/klines/client/api_client.py

@@ -90,11 +90,14 @@ class ApiClient:
         self.user_agent = "OpenAPI-Generator/1.0.0/python"
         self.client_side_validation = configuration.client_side_validation
 
-    def __enter__(self):
+    async def __aenter__(self):
         return self
 
-    def __exit__(self, exc_type, exc_value, traceback):
-        pass
+    async def __aexit__(self, exc_type, exc_value, traceback):
+        await self.close()
+
+    async def close(self):
+        await self.rest_client.close()
 
     @property
     def user_agent(self):
@@ -232,7 +235,7 @@ class ApiClient:
 
         return method, url, header_params, body, post_params
 
-    def call_api(
+    async def call_api(
         self,
         method,
         url,
@@ -255,7 +258,7 @@ class ApiClient:
 
         try:
             # perform request and return response
-            response_data = self.rest_client.request(
+            response_data = await self.rest_client.request(
                 method,
                 url,
                 headers=header_params,

crypticorn/klines/client/configuration.py

@@ -16,9 +16,8 @@ import copy
 import http.client as httplib
 import logging
 from logging import FileHandler
-import multiprocessing
 import sys
-from typing import Any, ClassVar, Dict, List, Literal, Optional, TypedDict
+from typing import Any, ClassVar, Dict, List, Literal, Optional, TypedDict, Union
 from typing_extensions import NotRequired, Self
 
 import urllib3
@@ -119,7 +118,10 @@ HTTPSignatureAuthSetting = TypedDict(
 
 AuthSettings = TypedDict(
     "AuthSettings",
-    {},
+    {
+        "HTTPBearer": BearerFormatAuthSetting,
+        "APIKeyHeader": APIKeyAuthSetting,
+    },
     total=False,
 )
 
@@ -139,34 +141,56 @@ class HostSetting(TypedDict):
 class Configuration:
     """This class contains various settings of the API client.
 
-    :param host: Base url.
-    :param ignore_operation_servers
-      Boolean to ignore operation servers for the API client.
-      Config will use `host` as the base url regardless of the operation servers.
-    :param api_key: Dict to store API key(s).
-      Each entry in the dict specifies an API key.
-      The dict key is the name of the security scheme in the OAS specification.
-      The dict value is the API key secret.
-    :param api_key_prefix: Dict to store API prefix (e.g. Bearer).
-      The dict key is the name of the security scheme in the OAS specification.
-      The dict value is an API key prefix when generating the auth data.
-    :param username: Username for HTTP basic authentication.
-    :param password: Password for HTTP basic authentication.
-    :param access_token: Access token.
-    :param server_index: Index to servers configuration.
-    :param server_variables: Mapping with string values to replace variables in
-      templated server configuration. The validation of enums is performed for
-      variables with defined enum values before.
-    :param server_operation_index: Mapping from operation ID to an index to server
-      configuration.
-    :param server_operation_variables: Mapping from operation ID to a mapping with
-      string values to replace variables in templated server configuration.
-      The validation of enums is performed for variables with defined enum
-      values before.
-    :param ssl_ca_cert: str - the path to a file of concatenated CA certificates
-      in PEM format.
-    :param retries: Number of retries for API requests.
-
+        :param host: Base url.
+        :param ignore_operation_servers
+          Boolean to ignore operation servers for the API client.
+          Config will use `host` as the base url regardless of the operation servers.
+        :param api_key: Dict to store API key(s).
+          Each entry in the dict specifies an API key.
+          The dict key is the name of the security scheme in the OAS specification.
+          The dict value is the API key secret.
+        :param api_key_prefix: Dict to store API prefix (e.g. Bearer).
+          The dict key is the name of the security scheme in the OAS specification.
+          The dict value is an API key prefix when generating the auth data.
+        :param username: Username for HTTP basic authentication.
+        :param password: Password for HTTP basic authentication.
+        :param access_token: Access token.
+        :param server_index: Index to servers configuration.
+        :param server_variables: Mapping with string values to replace variables in
+          templated server configuration. The validation of enums is performed for
+          variables with defined enum values before.
+        :param server_operation_index: Mapping from operation ID to an index to server
+          configuration.
+        :param server_operation_variables: Mapping from operation ID to a mapping with
+          string values to replace variables in templated server configuration.
+          The validation of enums is performed for variables with defined enum
+          values before.
+        :param ssl_ca_cert: str - the path to a file of concatenated CA certificates
+          in PEM format.
+        :param retries: Number of retries for API requests.
+        :param ca_cert_data: verify the peer using concatenated CA certificate data
+          in PEM (str) or DER (bytes) format.
+
+        :Example:
+
+        API Key Authentication Example.
+        Given the following security scheme in the OpenAPI specification:
+          components:
+            securitySchemes:
+              cookieAuth:         # name for the security scheme
+                type: apiKey
+                in: cookie
+                name: JSESSIONID  # cookie name
+
+        You can programmatically set the cookie:
+
+    conf = client.Configuration(
+        api_key={'cookieAuth': 'abc123'}
+        api_key_prefix={'cookieAuth': 'JSESSIONID'}
+    )
+
+        The following cookie will be added to the HTTP request:
+           Cookie: JSESSIONID abc123
     """
 
     _default: ClassVar[Optional[Self]] = None
@@ -186,6 +210,7 @@ class Configuration:
         ignore_operation_servers: bool = False,
         ssl_ca_cert: Optional[str] = None,
         retries: Optional[int] = None,
+        ca_cert_data: Optional[Union[str, bytes]] = None,
         *,
         debug: Optional[bool] = None,
     ) -> None:
@@ -262,6 +287,10 @@ class Configuration:
         self.ssl_ca_cert = ssl_ca_cert
         """Set this to customize the certificate file to verify the peer.
         """
+        self.ca_cert_data = ca_cert_data
+        """Set this to verify the peer using PEM (str) or DER (bytes)
+           certificate data.
+        """
         self.cert_file = None
         """client certificate file
         """
@@ -276,12 +305,9 @@ class Configuration:
            Set this to the SNI value expected by the server.
         """
 
-        self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
-        """urllib3 connection pool's maximum number of connections saved
-           per pool. urllib3 uses 1 connection as default value, but this is
-           not the best value when you are making a lot of possibly parallel
-           requests to the same host, which is often the case here.
-           cpu_count * 5 is used as default value to increase performance.
+        self.connection_pool_maxsize = 100
+        """This value is passed to the aiohttp to limit simultaneous connections.
+           Default values is 100, None means no-limit.
         """
 
         self.proxy: Optional[str] = None
@@ -492,6 +518,23 @@ class Configuration:
         :return: The Auth Settings information dict.
         """
         auth: AuthSettings = {}
+        if self.access_token is not None:
+            auth["HTTPBearer"] = {
+                "type": "bearer",
+                "in": "header",
+                "format": "JWT",
+                "key": "Authorization",
+                "value": "Bearer " + self.access_token,
+            }
+        if "APIKeyHeader" in self.api_key:
+            auth["APIKeyHeader"] = {
+                "type": "api_key",
+                "in": "header",
+                "key": "X-API-Key",
+                "value": self.get_api_key_with_prefix(
+                    "APIKeyHeader",
+                ),
+            }
         return auth
 
     def to_debug_report(self) -> str:

crypticorn/klines/client/models/__init__.py

@@ -17,6 +17,9 @@ Do not edit the class manually.
 from crypticorn.klines.client.models.base_response_health_check_response import (
     BaseResponseHealthCheckResponse,
 )
+from crypticorn.klines.client.models.base_response_list_change_in_timeframe_response import (
+    BaseResponseListChangeInTimeframeResponse,
+)
 from crypticorn.klines.client.models.base_response_list_funding_rate_response import (
     BaseResponseListFundingRateResponse,
 )
@@ -24,6 +27,9 @@ from crypticorn.klines.client.models.base_response_list_str import BaseResponseL
 from crypticorn.klines.client.models.base_response_ohlcv_response import (
     BaseResponseOHLCVResponse,
 )
+from crypticorn.klines.client.models.change_in_timeframe_response import (
+    ChangeInTimeframeResponse,
+)
 from crypticorn.klines.client.models.error_response import ErrorResponse
 from crypticorn.klines.client.models.exchange import Exchange
 from crypticorn.klines.client.models.funding_rate_response import FundingRateResponse
@@ -36,11 +42,11 @@ from crypticorn.klines.client.models.history_no_data_response import (
 from crypticorn.klines.client.models.history_success_response import (
     HistorySuccessResponse,
 )
-from crypticorn.klines.client.models.market import Market
+from crypticorn.klines.client.models.market_type import MarketType
 from crypticorn.klines.client.models.ohlcv_response import OHLCVResponse
 from crypticorn.klines.client.models.resolution import Resolution
-from crypticorn.klines.client.models.response_get_history_udf_history_get import (
-    ResponseGetHistoryUdfHistoryGet,
+from crypticorn.klines.client.models.response_get_udf_history import (
+    ResponseGetUdfHistory,
 )
 from crypticorn.klines.client.models.search_symbol_response import SearchSymbolResponse
 from crypticorn.klines.client.models.sort_direction import SortDirection

crypticorn/klines/client/models/base_response_list_change_in_timeframe_response.py

@@ -0,0 +1,123 @@
+# coding: utf-8
+
+"""
+Klines Service API
+
+     API for retrieving OHLCV data, funding rates, and symbol information from Binance.          ## WebSocket Support     Connect to `/ws` to receive real-time OHLCV updates.          Example subscription message:     ```json     {         \"action\": \"subscribe\",         \"market\": \"spot\",         \"symbol\": \"BTCUSDT\",         \"timeframe\": \"15m\"     }     ```
+
+The version of the OpenAPI document: 1.0.0
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from crypticorn.klines.client.models.change_in_timeframe_response import (
+    ChangeInTimeframeResponse,
+)
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class BaseResponseListChangeInTimeframeResponse(BaseModel):
+    """
+    BaseResponseListChangeInTimeframeResponse
+    """  # noqa: E501
+
+    success: Optional[StrictBool] = True
+    message: Optional[StrictStr] = None
+    data: Optional[List[ChangeInTimeframeResponse]] = None
+    timestamp: Optional[datetime] = None
+    __properties: ClassVar[List[str]] = ["success", "message", "data", "timestamp"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of BaseResponseListChangeInTimeframeResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in data (list)
+        _items = []
+        if self.data:
+            for _item_data in self.data:
+                if _item_data:
+                    _items.append(_item_data.to_dict())
+            _dict["data"] = _items
+        # set to None if message (nullable) is None
+        # and model_fields_set contains the field
+        if self.message is None and "message" in self.model_fields_set:
+            _dict["message"] = None
+
+        # set to None if data (nullable) is None
+        # and model_fields_set contains the field
+        if self.data is None and "data" in self.model_fields_set:
+            _dict["data"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BaseResponseListChangeInTimeframeResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "success": (
+                    obj.get("success") if obj.get("success") is not None else True
+                ),
+                "message": obj.get("message"),
+                "data": (
+                    [
+                        ChangeInTimeframeResponse.from_dict(_item)
+                        for _item in obj["data"]
+                    ]
+                    if obj.get("data") is not None
+                    else None
+                ),
+                "timestamp": obj.get("timestamp"),
+            }
+        )
+        return _obj

crypticorn/klines/client/models/change_in_timeframe_response.py

@@ -0,0 +1,86 @@
+# coding: utf-8
+
+"""
+Klines Service API
+
+     API for retrieving OHLCV data, funding rates, and symbol information from Binance.          ## WebSocket Support     Connect to `/ws` to receive real-time OHLCV updates.          Example subscription message:     ```json     {         \"action\": \"subscribe\",         \"market\": \"spot\",         \"symbol\": \"BTCUSDT\",         \"timeframe\": \"15m\"     }     ```
+
+The version of the OpenAPI document: 1.0.0
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class ChangeInTimeframeResponse(BaseModel):
+    """
+    ChangeInTimeframeResponse
+    """  # noqa: E501
+
+    pair: StrictStr
+    change: Union[StrictFloat, StrictInt]
+    __properties: ClassVar[List[str]] = ["pair", "change"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ChangeInTimeframeResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ChangeInTimeframeResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"pair": obj.get("pair"), "change": obj.get("change")}
+        )
+        return _obj

crypticorn/klines/client/models/market_type.py

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+"""
+Klines Service API
+
+     API for retrieving OHLCV data, funding rates, and symbol information from Binance.          ## WebSocket Support     Connect to `/ws` to receive real-time OHLCV updates.          Example subscription message:     ```json     {         \"action\": \"subscribe\",         \"market\": \"spot\",         \"symbol\": \"BTCUSDT\",         \"timeframe\": \"15m\"     }     ```
+
+The version of the OpenAPI document: 1.0.0
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class MarketType(str, Enum):
+    """
+    Market types
+    """
+
+    """
+    allowed enum values
+    """
+    SPOT = "spot"
+    FUTURES = "futures"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of MarketType from a JSON string"""
+        return cls(json.loads(json_str))

crypticorn/klines/client/models/response_get_udf_history.py

@@ -0,0 +1,198 @@
+# coding: utf-8
+
+"""
+Klines Service API
+
+     API for retrieving OHLCV data, funding rates, and symbol information from Binance.          ## WebSocket Support     Connect to `/ws` to receive real-time OHLCV updates.          Example subscription message:     ```json     {         \"action\": \"subscribe\",         \"market\": \"spot\",         \"symbol\": \"BTCUSDT\",         \"timeframe\": \"15m\"     }     ```
+
+The version of the OpenAPI document: 1.0.0
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+    StrictStr,
+    ValidationError,
+    field_validator,
+)
+from typing import Optional
+from crypticorn.klines.client.models.history_error_response import HistoryErrorResponse
+from crypticorn.klines.client.models.history_no_data_response import (
+    HistoryNoDataResponse,
+)
+from crypticorn.klines.client.models.history_success_response import (
+    HistorySuccessResponse,
+)
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+RESPONSEGETUDFHISTORY_ANY_OF_SCHEMAS = [
+    "HistoryErrorResponse",
+    "HistoryNoDataResponse",
+    "HistorySuccessResponse",
+]
+
+
+class ResponseGetUdfHistory(BaseModel):
+    """
+    ResponseGetUdfHistory
+    """
+
+    # data type: HistorySuccessResponse
+    anyof_schema_1_validator: Optional[HistorySuccessResponse] = None
+    # data type: HistoryNoDataResponse
+    anyof_schema_2_validator: Optional[HistoryNoDataResponse] = None
+    # data type: HistoryErrorResponse
+    anyof_schema_3_validator: Optional[HistoryErrorResponse] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[
+            Union[HistoryErrorResponse, HistoryNoDataResponse, HistorySuccessResponse]
+        ] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = {
+        "HistoryErrorResponse",
+        "HistoryNoDataResponse",
+        "HistorySuccessResponse",
+    }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError(
+                    "If a position argument is used, only 1 is allowed to set `actual_instance`"
+                )
+            if kwargs:
+                raise ValueError(
+                    "If a position argument is used, keyword arguments cannot be used."
+                )
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator("actual_instance")
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = ResponseGetUdfHistory.model_construct()
+        error_messages = []
+        # validate data type: HistorySuccessResponse
+        if not isinstance(v, HistorySuccessResponse):
+            error_messages.append(
+                f"Error! Input type `{type(v)}` is not `HistorySuccessResponse`"
+            )
+        else:
+            return v
+
+        # validate data type: HistoryNoDataResponse
+        if not isinstance(v, HistoryNoDataResponse):
+            error_messages.append(
+                f"Error! Input type `{type(v)}` is not `HistoryNoDataResponse`"
+            )
+        else:
+            return v
+
+        # validate data type: HistoryErrorResponse
+        if not isinstance(v, HistoryErrorResponse):
+            error_messages.append(
+                f"Error! Input type `{type(v)}` is not `HistoryErrorResponse`"
+            )
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError(
+                "No match found when setting the actual_instance in ResponseGetUdfHistory with anyOf schemas: HistoryErrorResponse, HistoryNoDataResponse, HistorySuccessResponse. Details: "
+                + ", ".join(error_messages)
+            )
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # anyof_schema_1_validator: Optional[HistorySuccessResponse] = None
+        try:
+            instance.actual_instance = HistorySuccessResponse.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[HistoryNoDataResponse] = None
+        try:
+            instance.actual_instance = HistoryNoDataResponse.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # anyof_schema_3_validator: Optional[HistoryErrorResponse] = None
+        try:
+            instance.actual_instance = HistoryErrorResponse.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError(
+                "No match found when deserializing the JSON string into ResponseGetUdfHistory with anyOf schemas: HistoryErrorResponse, HistoryNoDataResponse, HistorySuccessResponse. Details: "
+                + ", ".join(error_messages)
+            )
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(
+            self.actual_instance.to_json
+        ):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(
+        self,
+    ) -> Optional[
+        Union[
+            Dict[str, Any],
+            HistoryErrorResponse,
+            HistoryNoDataResponse,
+            HistorySuccessResponse,
+        ]
+    ]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(
+            self.actual_instance.to_dict
+        ):
+            return self.actual_instance.to_dict()
+        else:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())