crypticorn 2.4.6__tar.gz → 2.5.0__tar.gz

{crypticorn-2.4.6 → crypticorn-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.4.6
+Version: 2.5.0
 Summary: Maximise Your Crypto Trading Profits with AI Predictions
 Author-email: Crypticorn <timon@crypticorn.com>
 Project-URL: Homepage, https://crypticorn.com
@@ -21,19 +21,23 @@ Requires-Dist: aiohttp<4.0.0,>=3.8.4
 Requires-Dist: aiohttp-retry<3.0.0,>=2.8.3
 Requires-Dist: pydantic<3.0.0,>=2.0.0
 Requires-Dist: typing-extensions<5.0.0,>=4.7.1
-Requires-Dist: pandas<3.0.0,>=2.2.0
 Requires-Dist: requests<3.0.0,>=2.32.0
 Requires-Dist: tqdm<5.0.0,>=4.67.0
 Provides-Extra: dev
 Requires-Dist: streamlit; extra == "dev"
 Requires-Dist: httpx; extra == "dev"
 Requires-Dist: black; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
 Requires-Dist: openapi-generator-cli<8.0.0,>=7.12.0; extra == "dev"
 Provides-Extra: test
 Requires-Dist: pytest==8.3.5; extra == "test"
 Requires-Dist: pytest-asyncio==0.26.0; extra == "test"
 Requires-Dist: pytest-cov==6.1.1; extra == "test"
 Requires-Dist: python-dotenv==1.0.1; extra == "test"
+Provides-Extra: extra
+Requires-Dist: pandas<3.0.0,>=2.2.0; extra == "extra"
 
 # What is Crypticorn?
 
@@ -49,6 +53,8 @@ cryptocurrency market.
 
 ## Installation
 
+>Python 3.10+ required
+
 You can install the latest stable version from PyPi:
 ```bash
 pip install crypticorn

{crypticorn-2.4.6 → crypticorn-2.5.0}/README.md

@@ -12,6 +12,8 @@ cryptocurrency market.
 
 ## Installation
 
+>Python 3.10+ required
+
 You can install the latest stable version from PyPi:
 ```bash
 pip install crypticorn

{crypticorn-2.4.6 → crypticorn-2.5.0}/crypticorn/cli/init.py

@@ -57,7 +57,10 @@ def init_ruff(force):
 def init_docker(output, force):
     """Add Dockerfile"""
     root = get_git_root()
-    target = Path(output) if output else root / "Dockerfile"
+    if output and Path(output).is_file():
+        click.secho("Output path is a file, please provide a directory path", fg="red")
+        return
+    target = (Path(output) if output else root) / "Dockerfile"
     if target.exists() and not force:
         click.secho("File already exists, use --force / -f to overwrite", fg="red")
         return
@@ -73,10 +76,10 @@ def init_docker(output, force):
 def init_auth(output, force):
     """Add auth.py with auth handler. Everything you need to start using the auth service."""
     root = get_git_root()
-    if Path(output).is_dir():
-        click.secho("Output path is a directory, please provide a file path", fg="red")
+    if output and Path(output).is_file():
+        click.secho("Output path is a file, please provide a directory path", fg="red")
         return
-    target = Path(output) if output else root / "src/auth.py"
+    target = (Path(output) if output else root) / "auth.py"
     if target.exists() and not force:
         click.secho("File already exists, use --force / -f to overwrite", fg="red")
         return

{crypticorn-2.4.6 → crypticorn-2.5.0}/crypticorn/common/__init__.py

@@ -5,3 +5,4 @@ from crypticorn.common.pydantic import *
 from crypticorn.common.auth import *
 from crypticorn.common.enums import *
 from crypticorn.common.utils import *
+from crypticorn.common.exceptions import *

{crypticorn-2.4.6 → crypticorn-2.5.0}/crypticorn/common/auth.py

@@ -9,7 +9,7 @@ from crypticorn.common import (
     Scope,
     Service,
 )
-from fastapi import Depends, HTTPException, Query, status
+from fastapi import Depends, HTTPException, Query, status, WebSocketException
 from fastapi.security import (
     HTTPAuthorizationCredentials,
     SecurityScopes,
@@ -183,7 +183,7 @@ class AuthHandler:
         Verifies the API key and checks if the user scopes are a subset of the API scopes.
         Use this function if you only want to allow access via the API key.
         """
-        return await self.api_key_auth(api_key=api_key, sec=sec)
+        return await self.ws_combined_auth(bearer=None, api_key=api_key, sec=sec)
 
     async def ws_bearer_auth(
         self,
@@ -194,12 +194,7 @@ class AuthHandler:
         Verifies the bearer token and checks if the user scopes are a subset of the API scopes.
         Use this function if you only want to allow access via the bearer token.
         """
-        credentials = (
-            HTTPAuthorizationCredentials(scheme="Bearer", credentials=bearer)
-            if bearer
-            else None
-        )
-        return await self.bearer_auth(bearer=credentials, sec=sec)
+        return await self.ws_combined_auth(bearer=bearer, api_key=None, sec=sec)
 
     async def ws_combined_auth(
         self,
@@ -216,4 +211,11 @@ class AuthHandler:
             if bearer
             else None
         )
-        return await self.combined_auth(bearer=credentials, api_key=api_key, sec=sec)
+        response = await self.combined_auth(
+            bearer=credentials, api_key=api_key, sec=sec
+        )
+        if isinstance(response, HTTPException):
+            raise WebSocketException(
+                code=status.WS_1008_POLICY_VIOLATION, reason=response.detail
+            )
+        return response

{crypticorn-2.4.6 → crypticorn-2.5.0}/crypticorn/common/errors.py

@@ -36,6 +36,7 @@ class ApiErrorIdentifier(StrEnum):
 
     ALLOCATION_BELOW_EXPOSURE = "allocation_below_current_exposure"
     ALLOCATION_BELOW_MINIMUM = "allocation_below_min_amount"
+    ALPHANUMERIC_CHARACTERS_ONLY = "alphanumeric_characters_only"
     BLACK_SWAN = "black_swan"
     BOT_ALREADY_DELETED = "bot_already_deleted"
     BOT_DISABLED = "bot_disabled"
@@ -56,6 +57,7 @@ class ApiErrorIdentifier(StrEnum):
     EXCHANGE_SYSTEM_CONFIG_ERROR = "exchange_system_configuration_error"
     EXCHANGE_SYSTEM_ERROR = "exchange_internal_system_error"
     EXCHANGE_USER_FROZEN = "exchange_user_account_is_frozen"
+    FORBIDDEN = "forbidden"
     HEDGE_MODE_NOT_ACTIVE = "hedge_mode_not_active"
     HTTP_ERROR = "http_request_error"
     INSUFFICIENT_BALANCE = "insufficient_balance"
@@ -63,6 +65,8 @@ class ApiErrorIdentifier(StrEnum):
     INSUFFICIENT_SCOPES = "insufficient_scopes"
     INVALID_API_KEY = "invalid_api_key"
     INVALID_BEARER = "invalid_bearer"
+    INVALID_DATA_REQUEST = "invalid_data"
+    INVALID_DATA_RESPONSE = "invalid_data_response"
     INVALID_EXCHANGE_KEY = "invalid_exchange_key"
     INVALID_MARGIN_MODE = "invalid_margin_mode"
     INVALID_PARAMETER = "invalid_parameter_provided"
@@ -100,6 +104,11 @@ class ApiErrorIdentifier(StrEnum):
     UNKNOWN_ERROR = "unknown_error_occurred"
     URL_NOT_FOUND = "requested_resource_not_found"
 
+    @property
+    def get_error_code(self) -> str:
+        """Get the corresponding ApiError."""
+        return ApiError[self.value]
+
 
 class ApiErrorLevel(StrEnum):
     """API error levels"""
@@ -123,6 +132,11 @@ class ApiError(Enum, metaclass=Fallback):
         ApiErrorType.USER_ERROR,
         ApiErrorLevel.ERROR,
     )
+    ALPHANUMERIC_CHARACTERS_ONLY = (
+        ApiErrorIdentifier.ALPHANUMERIC_CHARACTERS_ONLY,
+        ApiErrorType.USER_ERROR,
+        ApiErrorLevel.ERROR,
+    )
     BLACK_SWAN = (
         ApiErrorIdentifier.BLACK_SWAN,
         ApiErrorType.USER_ERROR,
@@ -258,6 +272,16 @@ class ApiError(Enum, metaclass=Fallback):
         ApiErrorType.USER_ERROR,
         ApiErrorLevel.ERROR,
     )
+    INVALID_DATA_REQUEST = (
+        ApiErrorIdentifier.INVALID_DATA_REQUEST,
+        ApiErrorType.USER_ERROR,
+        ApiErrorLevel.ERROR,
+    )
+    INVALID_DATA_RESPONSE = (
+        ApiErrorIdentifier.INVALID_DATA_RESPONSE,
+        ApiErrorType.USER_ERROR,
+        ApiErrorLevel.ERROR,
+    )
     INVALID_EXCHANGE_KEY = (
         ApiErrorIdentifier.INVALID_EXCHANGE_KEY,
         ApiErrorType.SERVER_ERROR,
@@ -484,6 +508,8 @@ class HttpStatusMapper:
         ApiError.BOT_ALREADY_DELETED: status.HTTP_409_CONFLICT,
         # Invalid Content
         ApiError.CONTENT_TYPE_ERROR: status.HTTP_415_UNSUPPORTED_MEDIA_TYPE,
+        ApiError.INVALID_DATA_REQUEST: status.HTTP_422_UNPROCESSABLE_ENTITY,
+        ApiError.INVALID_DATA_RESPONSE: status.HTTP_422_UNPROCESSABLE_ENTITY,
         # Rate Limits
         ApiError.EXCHANGE_RATE_LIMIT: status.HTTP_429_TOO_MANY_REQUESTS,
         ApiError.REQUEST_SCOPE_EXCEEDED: status.HTTP_429_TOO_MANY_REQUESTS,

crypticorn-2.5.0/crypticorn/common/exceptions.py

@@ -0,0 +1,83 @@
+from enum import Enum
+from typing import Optional, Dict, Type, 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.'''
+    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")
+    level: ApiErrorLevel = Field(..., description="The level of the error")
+    status_code: int = Field(..., description="The HTTP status code")
+    details: Any = Field(None, description="Additional details about the error")
+
+
+class ExceptionContent(BaseModel):
+    '''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,
+            code=self.error.identifier,
+            type=self.error.type,
+            level=self.error.level,
+            status_code=self.error.status_code,
+            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.
+        The ApiError class is the source of truth for everything. If the error is not yet implemented, there are fallbacks to avoid errors while testing.
+    """
+
+    def __init__(
+        self,
+        content: ExceptionContent,
+        headers: Optional[Dict[str, str]] = None,
+    ):
+        assert isinstance(content, ExceptionContent)
+        body = content.enrich()
+        super().__init__(
+            status_code=body.status_code,
+            detail=body.model_dump(mode="json"),
+            headers=headers,
+        )
+
+async def general_handler(request: Request, exc: Exception):
+    '''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)
+
+async def request_validation_handler(request: Request, exc: RequestValidationError):
+    '''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)
+
+async def response_validation_handler(request: Request, exc: ResponseValidationError):
+    '''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)
+
+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.'''
+    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.'''
+    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-2.4.6 → crypticorn-2.5.0}/crypticorn/common/utils.py

@@ -1,27 +1,29 @@
-from typing import Any
+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
 
 
-def throw_if_none(value: Any, message: ApiError) -> None:
+def throw_if_none(value: Any, message: Union[ApiError, str]) -> 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
+            status_code=status.HTTP_404_NOT_FOUND,
+            detail=message.identifier if isinstance(message, ApiError) else message,
         )
 
 
-def throw_if_falsy(value: Any, message: ApiError) -> None:
+def throw_if_falsy(value: Any, message: Union[ApiError, str]) -> 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
+            status_code=status.HTTP_400_BAD_REQUEST,
+            detail=message.identifier if isinstance(message, ApiError) else message,
         )
 
 
@@ -32,6 +34,7 @@ def gen_random_id(length: int = 20) -> str:
     return "".join(random.choice(charset) for _ in range(length))
 
 
+@deprecated("Use math.isclose instead. Will be removed in a future version.")
 def is_equal(
     a: float | Decimal,
     b: float | Decimal,
@@ -50,3 +53,17 @@ def is_equal(
     return Decimal(abs(a - b)) <= max(
         Decimal(str(rel_tol)) * max(abs(a), abs(b)), Decimal(str(abs_tol))
     )
+
+
+def optional_import(module_name: str, extra_name: str) -> Any:
+    """
+    Import a module optionally.
+    """
+    try:
+        return __import__(module_name)
+    except ImportError as e:
+        extra = f"[{extra_name}]"
+        raise ImportError(
+            f"Optional dependency '{module_name}' is required for this feature. "
+            f"Install it with: pip install crypticorn{extra}"
+        ) from e

{crypticorn-2.4.6 → crypticorn-2.5.0}/crypticorn/klines/client/__init__.py

@@ -17,6 +17,7 @@ Do not edit the class manually.
 __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
@@ -38,6 +39,9 @@ from crypticorn.klines.client.exceptions import ApiException
 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,
 )
@@ -45,6 +49,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
@@ -57,11 +64,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-2.4.6 → crypticorn-2.5.0}/crypticorn/klines/client/api/__init__.py

@@ -1,6 +1,7 @@
 # flake8: noqa
 
 # 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