crypticorn 2.5.0rc5__py3-none-any.whl → 2.5.2__py3-none-any.whl

crypticorn/common/exceptions.py

@@ -1,14 +1,14 @@
-from enum import Enum
-from typing import Optional, Dict, Type, Any
+from typing import Optional, Dict, Any
 from pydantic import BaseModel, Field
 from fastapi import HTTPException as FastAPIHTTPException, Request, FastAPI
 from fastapi.exceptions import RequestValidationError, ResponseValidationError
-from fastapi.openapi.utils import get_openapi
 from fastapi.responses import JSONResponse
 from crypticorn.common import ApiError, ApiErrorIdentifier, ApiErrorType, ApiErrorLevel
 
+
 class ExceptionDetail(BaseModel):
-    '''This is the detail of the exception. It is used to enrich the exception with additional information by unwrapping the ApiError into its components.'''
+    """This is the detail of the exception. It is used to enrich the exception with additional information by unwrapping the ApiError into its components."""
+
     message: Optional[str] = Field(None, description="An additional error message")
     code: ApiErrorIdentifier = Field(..., description="The unique error code")
     type: ApiErrorType = Field(..., description="The type of error")
@@ -18,11 +18,12 @@ class ExceptionDetail(BaseModel):
 
 
 class ExceptionContent(BaseModel):
-    '''This is the detail of the exception. Pass an ApiError to the constructor and an optional human readable message.'''
+    """This is the detail of the exception. Pass an ApiError to the constructor and an optional human readable message."""
+
     error: ApiError = Field(..., description="The unique error code")
     message: Optional[str] = Field(None, description="An additional error message")
     details: Any = Field(None, description="Additional details about the error")
-        
+
     def enrich(self) -> ExceptionDetail:
         return ExceptionDetail(
             message=self.message,
@@ -33,6 +34,7 @@ class ExceptionContent(BaseModel):
             details=self.details,
         )
 
+
 class HTTPException(FastAPIHTTPException):
     """A custom HTTP exception wrapper around FastAPI's HTTPException.
     It allows for a more structured way to handle errors, with a message and an error code. The status code is being derived from the detail's error.
@@ -52,32 +54,44 @@ class HTTPException(FastAPIHTTPException):
             headers=headers,
         )
 
+
 async def general_handler(request: Request, exc: Exception):
-    '''This is the default exception handler for all exceptions.'''
+    """This is the default exception handler for all exceptions."""
     body = ExceptionContent(message=str(exc), error=ApiError.UNKNOWN_ERROR)
-    return JSONResponse(status_code=body.error.status_code, content=HTTPException(content=body).detail)
+    return JSONResponse(
+        status_code=body.error.status_code, content=HTTPException(content=body).detail
+    )
+
 
 async def request_validation_handler(request: Request, exc: RequestValidationError):
-    '''This is the exception handler for all request validation errors.'''
+    """This is the exception handler for all request validation errors."""
     body = ExceptionContent(message=str(exc), error=ApiError.INVALID_DATA_REQUEST)
-    return JSONResponse(status_code=body.error.status_code, content=HTTPException(content=body).detail)
+    return JSONResponse(
+        status_code=body.error.status_code, content=HTTPException(content=body).detail
+    )
+
 
 async def response_validation_handler(request: Request, exc: ResponseValidationError):
-    '''This is the exception handler for all response validation errors.'''
+    """This is the exception handler for all response validation errors."""
     body = ExceptionContent(message=str(exc), error=ApiError.INVALID_DATA_RESPONSE)
-    return JSONResponse(status_code=body.error.status_code, content=HTTPException(content=body).detail)
+    return JSONResponse(
+        status_code=body.error.status_code, content=HTTPException(content=body).detail
+    )
+
 
 async def http_handler(request: Request, exc: HTTPException):
-    '''This is the exception handler for HTTPExceptions. It unwraps the HTTPException and returns the detail in a flat JSON response.'''
+    """This is the exception handler for HTTPExceptions. It unwraps the HTTPException and returns the detail in a flat JSON response."""
     return JSONResponse(status_code=exc.status_code, content=exc.detail)
 
+
 def register_exception_handlers(app: FastAPI):
-    '''Utility to register serveral exception handlers in one go. Catches Exception, HTTPException and Data Validation errors and responds with a unified json body.'''
+    """Utility to register serveral exception handlers in one go. Catches Exception, HTTPException and Data Validation errors and responds with a unified json body."""
     app.add_exception_handler(Exception, general_handler)
     app.add_exception_handler(FastAPIHTTPException, http_handler)
     app.add_exception_handler(RequestValidationError, request_validation_handler)
     app.add_exception_handler(ResponseValidationError, response_validation_handler)
 
+
 exception_response = {
     "default": {"model": ExceptionDetail, "description": "Error response"}
-}
+}

crypticorn/common/mixins.py

@@ -0,0 +1,37 @@
+class ValidateEnumMixin:
+    """
+    Mixin for validating enum values manually.
+
+    ⚠️ Note:
+    This does NOT enforce validation automatically on enum creation.
+    It's up to the developer to call `Class.validate(value)` where needed.
+
+    Usage:
+        >>> class Color(ValidateEnumMixin, StrEnum):
+        >>>     RED = "red"
+        >>>     GREEN = "green"
+
+        >>> Color.validate("red")     # True
+        >>> Color.validate("yellow")  # False
+
+    Order of inheritance matters — the mixin must come first.
+    """
+
+    @classmethod
+    def validate(cls, value) -> bool:
+        """Validate if a value is in the enum. True if so, False otherwise."""
+        try:
+            cls(value)
+            return True
+        except ValueError:
+            return False
+
+
+class ExcludeEnumMixin:
+    """Mixin to exclude enum from OpenAPI schema. We use this to avoid duplicating enums when generating client code from the openapi spec."""
+
+    @classmethod
+    def __get_pydantic_json_schema__(cls, core_schema, handler):
+        schema = handler(core_schema)
+        schema.pop("enum", None)
+        return schema

crypticorn/common/status_router.py

@@ -0,0 +1,42 @@
+from datetime import datetime
+from typing import Literal
+from fastapi import APIRouter
+
+router = APIRouter(tags=["Status"], prefix="")
+
+@router.get("/", operation_id="ping")
+async def ping() -> str:
+    """
+    Returns 'OK' if the API is running.
+    """
+    return "OK"
+
+@router.get("/time", operation_id="getTime")
+async def time(
+    type: Literal["iso", "unix"] = "iso"
+) -> str:
+    """
+    Returns the current time in the specified format.
+    """
+    if type == "iso":
+        return datetime.now().isoformat()
+    else:
+        return str(int(datetime.now().timestamp()))
+    
+@router.get("/config", operation_id="getConfig")
+async def config() -> dict:
+    """
+    Returns the version of the crypticorn library and the environment.
+    """
+    import importlib.metadata
+    import os
+    from dotenv import load_dotenv
+    load_dotenv()
+    try: 
+        crypticorn_version = importlib.metadata.version("flask")
+    except importlib.metadata.PackageNotFoundError:
+        crypticorn_version = "not installed"
+    return {
+        "crypticorn": crypticorn_version,
+        "environment": os.getenv("API_ENV", "not set"),
+    }

crypticorn/common/urls.py

@@ -1,4 +1,5 @@
 from enum import StrEnum
+from crypticorn.common.enums import ValidateEnumMixin
 
 
 class ApiEnv(StrEnum):
@@ -30,7 +31,7 @@ class ApiVersion(StrEnum):
     V1 = "v1"
 
 
-class Service(StrEnum):
+class Service(ValidateEnumMixin, StrEnum):
     HIVE = "hive"
     KLINES = "klines"
     PAY = "pay"

crypticorn/common/utils.py

@@ -2,30 +2,22 @@ from typing import Any, Union
 from decimal import Decimal
 import string
 import random
-
-from fastapi import HTTPException
 from fastapi import status
 from typing_extensions import deprecated
 
-from crypticorn.common import ApiError
+from crypticorn.common import ApiError, HTTPException, ExceptionContent
 
 
-def throw_if_none(value: Any, message: Union[ApiError, str]) -> None:
+def throw_if_none(value: Any, error: ApiError = ApiError.OBJECT_NOT_FOUND) -> None:
     """Throws an FastAPI HTTPException if the value is None."""
     if value is None:
-        raise HTTPException(
-            status_code=status.HTTP_404_NOT_FOUND,
-            detail=message.identifier if isinstance(message, ApiError) else message,
-        )
+        raise HTTPException(content=ExceptionContent(error=error))
 
 
-def throw_if_falsy(value: Any, message: Union[ApiError, str]) -> None:
+def throw_if_falsy(value: Any, error: ApiError = ApiError.OBJECT_NOT_FOUND) -> None:
     """Throws an FastAPI HTTPException if the value is False."""
     if not value:
-        raise HTTPException(
-            status_code=status.HTTP_400_BAD_REQUEST,
-            detail=message.identifier if isinstance(message, ApiError) else message,
-        )
+        raise HTTPException(content=ExceptionContent(error=error))
 
 
 def gen_random_id(length: int = 20) -> str:
@@ -56,7 +48,10 @@ def is_equal(
     )
 
 
-def optional_import(module_name: str, extra_name: str):
+def optional_import(module_name: str, extra_name: str) -> Any:
+    """
+    Import a module optionally.
+    """
     try:
         return __import__(module_name)
     except ImportError as e:

crypticorn/hive/main.py

@@ -14,6 +14,8 @@ class HiveClient:
     A client for interacting with the Crypticorn Hive API.
     """
 
+    config_class = Configuration
+
     def __init__(
         self,
         config: Configuration,

crypticorn/klines/client/__init__.py

@@ -5,7 +5,7 @@
 """
 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\"     }     ```
+API for retrieving OHLCV data, funding rates, and symbol information from Binance.
 
 The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -19,8 +19,8 @@ __version__ = "1.0.0"
 # import apis into sdk package
 from crypticorn.klines.client.api.change_in_timeframe_api import ChangeInTimeframeApi
 from crypticorn.klines.client.api.funding_rates_api import FundingRatesApi
-from crypticorn.klines.client.api.health_check_api import HealthCheckApi
 from crypticorn.klines.client.api.ohlcv_data_api import OHLCVDataApi
+from crypticorn.klines.client.api.status_api import StatusApi
 from crypticorn.klines.client.api.symbols_api import SymbolsApi
 from crypticorn.klines.client.api.udf_api import UDFApi
 
@@ -36,48 +36,15 @@ from crypticorn.klines.client.exceptions import ApiAttributeError
 from crypticorn.klines.client.exceptions import ApiException
 
 # import models into sdk package
-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,
-)
-from crypticorn.klines.client.models.base_response_list_str import BaseResponseListStr
-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
-from crypticorn.klines.client.models.http_validation_error import HTTPValidationError
-from crypticorn.klines.client.models.health_check_response import HealthCheckResponse
-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 crypticorn.klines.client.models.market_type import MarketType
-from crypticorn.klines.client.models.ohlcv_response import OHLCVResponse
+from crypticorn.klines.client.models.change_in_timeframe import ChangeInTimeframe
+from crypticorn.klines.client.models.exception_detail import ExceptionDetail
+from crypticorn.klines.client.models.funding_rate import FundingRate
+from crypticorn.klines.client.models.ohlcv_history import OHLCVHistory
 from crypticorn.klines.client.models.resolution import Resolution
-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.search_symbol import SearchSymbol
 from crypticorn.klines.client.models.sort_direction import SortDirection
-from crypticorn.klines.client.models.symbol_group_response import SymbolGroupResponse
-from crypticorn.klines.client.models.symbol_info_response import SymbolInfoResponse
+from crypticorn.klines.client.models.symbol_group import SymbolGroup
+from crypticorn.klines.client.models.symbol_info import SymbolInfo
 from crypticorn.klines.client.models.symbol_type import SymbolType
 from crypticorn.klines.client.models.timeframe import Timeframe
-from crypticorn.klines.client.models.udf_config_response import UDFConfigResponse
-from crypticorn.klines.client.models.validation_error import ValidationError
-from crypticorn.klines.client.models.validation_error_loc_inner import (
-    ValidationErrorLocInner,
-)
+from crypticorn.klines.client.models.udf_config import UDFConfig

crypticorn/klines/client/api/__init__.py

@@ -3,7 +3,7 @@
 # import apis into api package
 from crypticorn.klines.client.api.change_in_timeframe_api import ChangeInTimeframeApi
 from crypticorn.klines.client.api.funding_rates_api import FundingRatesApi
-from crypticorn.klines.client.api.health_check_api import HealthCheckApi
 from crypticorn.klines.client.api.ohlcv_data_api import OHLCVDataApi
+from crypticorn.klines.client.api.status_api import StatusApi
 from crypticorn.klines.client.api.symbols_api import SymbolsApi
 from crypticorn.klines.client.api.udf_api import UDFApi

crypticorn/klines/client/api/change_in_timeframe_api.py

@@ -3,7 +3,7 @@
 """
 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\"     }     ```
+API for retrieving OHLCV data, funding rates, and symbol information from Binance.
 
 The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -16,13 +16,10 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
 from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
-from pydantic import Field
-from typing import Optional
+from pydantic import Field, StrictStr
+from typing import List, Optional
 from typing_extensions import Annotated
-from crypticorn.klines.client.models.base_response_list_change_in_timeframe_response import (
-    BaseResponseListChangeInTimeframeResponse,
-)
-from crypticorn.klines.client.models.market_type import MarketType
+from crypticorn.klines.client.models.change_in_timeframe import ChangeInTimeframe
 from crypticorn.klines.client.models.timeframe import Timeframe
 
 from crypticorn.klines.client.api_client import ApiClient, RequestSerialized
@@ -46,7 +43,7 @@ class ChangeInTimeframeApi:
     async def get_change_in_timeframe(
         self,
         market: Annotated[
-            Optional[MarketType], Field(description="Market type: 'spot' or 'futures'")
+            Optional[StrictStr], Field(description="Market type: 'spot' or 'futures'")
         ] = None,
         timeframe: Annotated[
             Optional[Timeframe],
@@ -63,13 +60,13 @@ class ChangeInTimeframeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> BaseResponseListChangeInTimeframeResponse:
+    ) -> List[ChangeInTimeframe]:
         """Get Change In Timeframe
 
         Retrieve price change percentage between last two completed timestamps for all pairs.  Valid markets: spot, futures Valid timeframes: 15m, 30m, 1h, 4h, 1d
 
         :param market: Market type: 'spot' or 'futures'
-        :type market: MarketType
+        :type market: str
         :param timeframe: Timeframe: '15m', '30m', '1h', '4h', '1d'
         :type timeframe: Timeframe
         :param _request_timeout: timeout setting for this request. If one
@@ -104,11 +101,7 @@ class ChangeInTimeframeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "BaseResponseListChangeInTimeframeResponse",
-            "400": "ErrorResponse",
-            "404": "ErrorResponse",
-            "500": "ErrorResponse",
-            "422": "HTTPValidationError",
+            "200": "List[ChangeInTimeframe]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -123,7 +116,7 @@ class ChangeInTimeframeApi:
     async def get_change_in_timeframe_with_http_info(
         self,
         market: Annotated[
-            Optional[MarketType], Field(description="Market type: 'spot' or 'futures'")
+            Optional[StrictStr], Field(description="Market type: 'spot' or 'futures'")
         ] = None,
         timeframe: Annotated[
             Optional[Timeframe],
@@ -140,13 +133,13 @@ class ChangeInTimeframeApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[BaseResponseListChangeInTimeframeResponse]:
+    ) -> ApiResponse[List[ChangeInTimeframe]]:
         """Get Change In Timeframe
 
         Retrieve price change percentage between last two completed timestamps for all pairs.  Valid markets: spot, futures Valid timeframes: 15m, 30m, 1h, 4h, 1d
 
         :param market: Market type: 'spot' or 'futures'
-        :type market: MarketType
+        :type market: str
         :param timeframe: Timeframe: '15m', '30m', '1h', '4h', '1d'
         :type timeframe: Timeframe
         :param _request_timeout: timeout setting for this request. If one
@@ -181,11 +174,7 @@ class ChangeInTimeframeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "BaseResponseListChangeInTimeframeResponse",
-            "400": "ErrorResponse",
-            "404": "ErrorResponse",
-            "500": "ErrorResponse",
-            "422": "HTTPValidationError",
+            "200": "List[ChangeInTimeframe]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -200,7 +189,7 @@ class ChangeInTimeframeApi:
     async def get_change_in_timeframe_without_preload_content(
         self,
         market: Annotated[
-            Optional[MarketType], Field(description="Market type: 'spot' or 'futures'")
+            Optional[StrictStr], Field(description="Market type: 'spot' or 'futures'")
         ] = None,
         timeframe: Annotated[
             Optional[Timeframe],
@@ -223,7 +212,7 @@ class ChangeInTimeframeApi:
         Retrieve price change percentage between last two completed timestamps for all pairs.  Valid markets: spot, futures Valid timeframes: 15m, 30m, 1h, 4h, 1d
 
         :param market: Market type: 'spot' or 'futures'
-        :type market: MarketType
+        :type market: str
         :param timeframe: Timeframe: '15m', '30m', '1h', '4h', '1d'
         :type timeframe: Timeframe
         :param _request_timeout: timeout setting for this request. If one
@@ -258,11 +247,7 @@ class ChangeInTimeframeApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "BaseResponseListChangeInTimeframeResponse",
-            "400": "ErrorResponse",
-            "404": "ErrorResponse",
-            "500": "ErrorResponse",
-            "422": "HTTPValidationError",
+            "200": "List[ChangeInTimeframe]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -296,7 +281,7 @@ class ChangeInTimeframeApi:
         # process the query parameters
         if market is not None:
 
-            _query_params.append(("market", market.value))
+            _query_params.append(("market", market))
 
         if timeframe is not None:
 

crypticorn/klines/client/api/funding_rates_api.py

@@ -3,7 +3,7 @@
 """
 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\"     }     ```
+API for retrieving OHLCV data, funding rates, and symbol information from Binance.
 
 The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -17,11 +17,9 @@ from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
 from pydantic import Field, StrictInt, StrictStr
-from typing import Optional
+from typing import List, Optional
 from typing_extensions import Annotated
-from crypticorn.klines.client.models.base_response_list_funding_rate_response import (
-    BaseResponseListFundingRateResponse,
-)
+from crypticorn.klines.client.models.funding_rate import FundingRate
 
 from crypticorn.klines.client.api_client import ApiClient, RequestSerialized
 from crypticorn.klines.client.api_response import ApiResponse
@@ -67,7 +65,7 @@ class FundingRatesApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> BaseResponseListFundingRateResponse:
+    ) -> List[FundingRate]:
         """Funding Rate
 
         Retrieve funding rate data for a specific symbol in the futures market.
@@ -114,11 +112,7 @@ class FundingRatesApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "BaseResponseListFundingRateResponse",
-            "400": "ErrorResponse",
-            "404": "ErrorResponse",
-            "500": "ErrorResponse",
-            "422": "HTTPValidationError",
+            "200": "List[FundingRate]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -156,7 +150,7 @@ class FundingRatesApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[BaseResponseListFundingRateResponse]:
+    ) -> ApiResponse[List[FundingRate]]:
         """Funding Rate
 
         Retrieve funding rate data for a specific symbol in the futures market.
@@ -203,11 +197,7 @@ class FundingRatesApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "BaseResponseListFundingRateResponse",
-            "400": "ErrorResponse",
-            "404": "ErrorResponse",
-            "500": "ErrorResponse",
-            "422": "HTTPValidationError",
+            "200": "List[FundingRate]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -292,11 +282,7 @@ class FundingRatesApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "BaseResponseListFundingRateResponse",
-            "400": "ErrorResponse",
-            "404": "ErrorResponse",
-            "500": "ErrorResponse",
-            "422": "HTTPValidationError",
+            "200": "List[FundingRate]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout