crypticorn 2.8.0rc9__py3-none-any.whl → 2.8.2__py3-none-any.whl

crypticorn/__init__.py

@@ -6,13 +6,9 @@ We adhere to [Semantic Versioning](https://semver.org/).
 You can find the full Changelog [below](#changelog).
 """
 
-import warnings
-import logging
 from crypticorn.common.logging import configure_logging
 
-warnings.filterwarnings("default", "", DeprecationWarning)
 configure_logging()
-logging.captureWarnings(True)
 
 from crypticorn.client import ApiClient
 

crypticorn/cli/init.py

@@ -1,7 +1,7 @@
 import click
 from pathlib import Path
 import subprocess
-import importlib.resources as pkg_resources
+import importlib.resources
 import crypticorn.cli.templates as templates
 
 
@@ -19,7 +19,7 @@ def get_git_root() -> Path:
 
 def copy_template(template_name: str, target_path: Path):
     """Copy a template file to the target path."""
-    with pkg_resources.files(templates).joinpath(template_name).open(
+    with importlib.resources.files(templates).joinpath(template_name).open(
         "r"
     ) as template_file:
         content = template_file.read()

crypticorn/common/__init__.py

@@ -11,7 +11,5 @@ from crypticorn.common.pagination import *
 from crypticorn.common.logging import *
 from crypticorn.common.ansi_colors import *
 from crypticorn.common.middleware import *
-from crypticorn.common.warnings import *
-from crypticorn.common.openapi import *
 from crypticorn.common.router.status_router import router as status_router
 from crypticorn.common.router.admin_router import router as admin_router

crypticorn/common/ansi_colors.py

@@ -1,9 +1,8 @@
 from enum import StrEnum
+from typing import TYPE_CHECKING
 
 
 class AnsiColors(StrEnum):
-    """Provides a collection of ANSI color codes for terminal text formatting, including regular, bright, and bold text colors. Useful for creating colorful and readable console output."""
-
     # Regular Text Colors
     BLACK = "\033[30m"  # black
     RED = "\033[31m"  # red

crypticorn/common/auth.py

@@ -38,8 +38,8 @@ class AuthHandler:
     """
     Middleware for verifying API requests. Verifies the validity of the authentication token, scopes, etc.
 
-    :param base_url: The base URL of the API.
-    :param api_version: The version of the API.
+    @param base_url: The base URL of the API.
+    @param api_version: The version of the API.
     """
 
     def __init__(

crypticorn/common/enums.py

@@ -1,5 +1,3 @@
-"""Defines common enumerations used throughout the codebase for type safety and consistency."""
-
 from enum import StrEnum
 from crypticorn.common.mixins import ValidateEnumMixin, ExcludeEnumMixin
 

crypticorn/common/errors.py

@@ -1,12 +1,10 @@
-"""Comprehensive error handling system defining various API error types, HTTP exceptions, and error content structures."""
-
 from enum import Enum, StrEnum
 from fastapi import status
 from crypticorn.common.mixins import ExcludeEnumMixin, ApiErrorFallback
 
 
 class ApiErrorType(ExcludeEnumMixin, StrEnum):
-    """Type of the API error."""
+    """Type of API error"""
 
     USER_ERROR = "user error"
     """user error by people using our services"""
@@ -19,7 +17,7 @@ class ApiErrorType(ExcludeEnumMixin, StrEnum):
 
 
 class ApiErrorIdentifier(ExcludeEnumMixin, StrEnum):
-    """Unique identifier of the API error."""
+    """API error identifiers"""
 
     ALLOCATION_BELOW_EXPOSURE = "allocation_below_current_exposure"
     ALLOCATION_BELOW_MINIMUM = "allocation_below_min_amount"
@@ -105,7 +103,7 @@ class ApiErrorIdentifier(ExcludeEnumMixin, StrEnum):
 
 
 class ApiErrorLevel(ExcludeEnumMixin, StrEnum):
-    """Level of the API error."""
+    """API error levels"""
 
     ERROR = "error"
     INFO = "info"
@@ -114,8 +112,7 @@ class ApiErrorLevel(ExcludeEnumMixin, StrEnum):
 
 
 class ApiError(ExcludeEnumMixin, Enum, metaclass=ApiErrorFallback):
-    # Fallback to UNKNOWN_ERROR for error codes not yet published to PyPI.
-    """Crypticorn API error enumeration."""
+    """API error codes. Fallback to UNKNOWN_ERROR for error codes not yet published to PyPI."""
 
     ALLOCATION_BELOW_EXPOSURE = (
         ApiErrorIdentifier.ALLOCATION_BELOW_EXPOSURE,
@@ -521,7 +518,7 @@ class ApiError(ExcludeEnumMixin, Enum, metaclass=ApiErrorFallback):
 
 
 class StatusCodeMapper:
-    """Mapping of API errors to HTTP/Websocket status codes."""
+    """Map API errors to HTTP status codes."""
 
     _mapping = {
         # Authentication/Authorization

crypticorn/common/exceptions.py

@@ -1,4 +1,4 @@
-from typing import Optional, Dict, Any
+from typing import Optional, Dict, Any, Literal
 from enum import StrEnum
 from pydantic import BaseModel, Field
 from fastapi import HTTPException as FastAPIHTTPException, Request, FastAPI
@@ -8,18 +8,16 @@ from crypticorn.common import ApiError, ApiErrorIdentifier, ApiErrorType, ApiErr
 import logging
 import json
 
-_logger = logging.getLogger("crypticorn")
+logger = logging.getLogger("crypticorn")
 
 
-class _ExceptionType(StrEnum):
-    """The protocol the exception is called from"""
-
+class ExceptionType(StrEnum):
     HTTP = "http"
     WEBSOCKET = "websocket"
 
 
 class ExceptionDetail(BaseModel):
-    """Exception details returned to the client."""
+    """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")
@@ -30,14 +28,14 @@ class ExceptionDetail(BaseModel):
 
 
 class ExceptionContent(BaseModel):
-    """Exception content used when raising an exception."""
+    """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, _type: Optional[_ExceptionType] = _ExceptionType.HTTP
+        self, _type: Optional[ExceptionType] = ExceptionType.HTTP
     ) -> ExceptionDetail:
         return ExceptionDetail(
             message=self.message,
@@ -46,7 +44,7 @@ class ExceptionContent(BaseModel):
             level=self.error.level,
             status_code=(
                 self.error.http_code
-                if _type == _ExceptionType.HTTP
+                if _type == ExceptionType.HTTP
                 else self.error.websocket_code
             ),
             details=self.details,
@@ -56,14 +54,14 @@ class ExceptionContent(BaseModel):
 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. If the error is not yet implemented, there are fallbacks in place.
+        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,
-        _type: Optional[_ExceptionType] = _ExceptionType.HTTP,
+        _type: Optional[ExceptionType] = ExceptionType.HTTP,
     ):
         self.content = content
         self.headers = headers
@@ -84,11 +82,11 @@ class WebSocketException(HTTPException):
     def __init__(
         self, content: ExceptionContent, headers: Optional[Dict[str, str]] = None
     ):
-        super().__init__(content, headers, _type=_ExceptionType.WEBSOCKET)
+        super().__init__(content, headers, _type=ExceptionType.WEBSOCKET)
 
     @classmethod
     def from_http_exception(cls, http_exception: HTTPException):
-        """Helper method to convert an HTTPException to a WebSocketException."""
+        """This is a helper method to convert an HTTPException to a WebSocketException."""
         return WebSocketException(
             content=http_exception.content,
             headers=http_exception.headers,
@@ -96,47 +94,46 @@ class WebSocketException(HTTPException):
 
 
 async def general_handler(request: Request, exc: Exception) -> JSONResponse:
-    """Default exception handler for all exceptions."""
+    """This is the default exception handler for all exceptions."""
     body = ExceptionContent(message=str(exc), error=ApiError.UNKNOWN_ERROR)
     res = JSONResponse(
         status_code=body.enrich().status_code,
         content=HTTPException(content=body).detail,
     )
-    _logger.error(f"Response validation error: {json.loads(res.__dict__.get('body'))}")
+    logger.error(f"Response validation error: {json.loads(res.__dict__.get('body'))}")
     return res
 
 
 async def request_validation_handler(
     request: Request, exc: RequestValidationError
 ) -> JSONResponse:
-    """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)
     res = JSONResponse(
         status_code=body.enrich().status_code,
         content=HTTPException(content=body).detail,
     )
-    _logger.error(f"Response validation error: {json.loads(res.__dict__.get('body'))}")
+    logger.error(f"Response validation error: {json.loads(res.__dict__.get('body'))}")
     return res
 
 
 async def response_validation_handler(
     request: Request, exc: ResponseValidationError
 ) -> JSONResponse:
-    """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)
     res = JSONResponse(
         status_code=body.enrich().status_code,
         content=HTTPException(content=body).detail,
     )
-    _logger.error(f"Response validation error: {json.loads(res.__dict__.get('body'))}")
+    logger.error(f"Response validation error: {json.loads(res.__dict__.get('body'))}")
     return res
 
 
 async def http_handler(request: Request, exc: HTTPException) -> JSONResponse:
-    """Exception handler for HTTPExceptions. It unwraps the HTTPException and returns the detail in a flat JSON response."""
-    res = JSONResponse(status_code=exc.status_code, content=exc.detail)
-    _logger.error(f"HTTP error: {json.loads(res.__dict__.get('body'))}")
-    return res
+    """This is the exception handler for HTTPExceptions. It unwraps the HTTPException and returns the detail in a flat JSON response."""
+    logger.error(f"HTTP error: {exc.detail}")
+    return JSONResponse(status_code=exc.status_code, content=exc.detail)
 
 
 def register_exception_handlers(app: FastAPI):

crypticorn/common/logging.py

@@ -1,7 +1,12 @@
 from __future__ import annotations
 
+# shared_logger.py
 import logging
 import sys
+from contextvars import ContextVar
+from contextlib import asynccontextmanager
+import json
+from pydantic import BaseModel
 from enum import StrEnum
 from crypticorn.common.mixins import ValidateEnumMixin
 from crypticorn.common.ansi_colors import AnsiColors as C
@@ -18,7 +23,6 @@ class LogLevel(ValidateEnumMixin, StrEnum):
 
     @classmethod
     def get_color(cls, level: str) -> str:
-        """Get the ansi color based on the log level."""
         if level == cls.DEBUG:
             return C.GREEN_BRIGHT
         elif level == cls.INFO:
@@ -34,12 +38,10 @@ class LogLevel(ValidateEnumMixin, StrEnum):
 
     @staticmethod
     def get_level(level: "LogLevel") -> int:
-        """Get the integer value from a log level name."""
         return logging._nameToLevel.get(level, logging.INFO)
 
     @staticmethod
     def get_name(level: int) -> "LogLevel":
-        """Get the level name from the integer value of a log level."""
         return LogLevel(logging._levelToName.get(level, "INFO"))
 
 
@@ -52,7 +54,7 @@ _LOGFORMAT = (
 _DATEFMT = "%Y-%m-%d %H:%M:%S.%f:"
 
 
-class _CustomFormatter(logging.Formatter):
+class CustomFormatter(logging.Formatter):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
@@ -97,7 +99,7 @@ def configure_logging(
     # Configure stdout handler
     stdout_handler = logging.StreamHandler(sys.stdout)
     stdout_handler.setLevel(stdout_level)
-    stdout_handler.setFormatter(_CustomFormatter(fmt=fmt, datefmt=datefmt))
+    stdout_handler.setFormatter(CustomFormatter(fmt=fmt, datefmt=datefmt))
     for filter in filters:
         stdout_handler.addFilter(filter)
     logger.addHandler(stdout_handler)
@@ -109,7 +111,7 @@ def configure_logging(
             log_file, maxBytes=10 * 1024 * 1024, backupCount=5
         )
         file_handler.setLevel(file_level)
-        file_handler.setFormatter(_CustomFormatter(fmt=fmt, datefmt=datefmt))
+        file_handler.setFormatter(CustomFormatter(fmt=fmt, datefmt=datefmt))
         for filter in filters:
             file_handler.addFilter(filter)
         logger.addHandler(file_handler)

crypticorn/common/middleware.py

@@ -1,7 +1,7 @@
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 from crypticorn.common.logging import configure_logging
-from contextlib import asynccontextmanager
+import logging
 
 
 def add_cors_middleware(app: "FastAPI"):
@@ -18,7 +18,6 @@ def add_cors_middleware(app: "FastAPI"):
     )
 
 
-@asynccontextmanager
 async def default_lifespan(app: FastAPI):
     """Default lifespan for the applications.
     This is used to configure the logging for the application.

crypticorn/common/mixins.py

@@ -1,9 +1,7 @@
 from enum import EnumMeta
 import logging
-import warnings
-from crypticorn.common.warnings import CrypticornDeprecatedSince28
 
-_logger = logging.getLogger("crypticorn")
+logger = logging.getLogger("uvicorn")
 
 
 class ValidateEnumMixin:
@@ -37,12 +35,7 @@ class ValidateEnumMixin:
 
 # This Mixin will be removed in a future version. And has no effect from now on
 class ExcludeEnumMixin:
-    """(deprecated) Mixin to exclude enum from OpenAPI schema. We use this to avoid duplicating enums when generating client code from the openapi spec."""
-
-    warnings.warn(
-        "The `ExcludeEnumMixin` class is deprecated. Should be removed from enums inheriting this class.",
-        category=CrypticornDeprecatedSince28,
-    )
+    """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):
@@ -58,7 +51,7 @@ class ApiErrorFallback(EnumMeta):
         # Let Pydantic/internal stuff pass silently ! fragile
         if name.startswith("__"):
             raise AttributeError(name)
-        _logger.warning(
+        logger.warning(
             f"Unknown enum member '{name}' - update crypticorn package or check for typos"
         )
         return cls.UNKNOWN_ERROR

crypticorn/common/pagination.py

@@ -1,5 +1,3 @@
-"""Utilities for handling paginated API responses and cursor-based pagination."""
-
 from typing import Generic, Type, TypeVar, List, Optional, Literal
 from pydantic import BaseModel, Field, model_validator
 

crypticorn/common/router/admin_router.py

@@ -6,7 +6,7 @@ ONLY ALLOW ACCESS TO THIS ROUTER WITH ADMIN SCOPES.
 """
 
 import os
-import pkg_resources
+import importlib.metadata
 import threading
 import time
 import psutil
@@ -90,11 +90,9 @@ def list_installed_packages(
     )
 ) -> list:
     """Return a list of installed packages and versions."""
-    return sorted(
-        [
-            {dist.project_name: dist.version}
-            for dist in pkg_resources.working_set
-            if include is None or dist.project_name in include
-        ],
-        key=lambda x: next(iter(x)),
-    )
+    packages = {
+        dist.metadata["Name"]: dist.version
+        for dist in importlib.metadata.distributions()
+        if include is None or dist.metadata["Name"] in include
+    }
+    return dict(sorted(packages.items()))

crypticorn/common/router/status_router.py

@@ -1,10 +1,3 @@
-"""
-This module contains the status router for the API.
-It provides endpoints for checking the status of the API and get the server's time.
-SHOULD ALLOW ACCESS TO THIS ROUTER WITHOUT.
->>> app.include_router(status_router)
-"""
-
 from datetime import datetime
 from typing import Literal
 from fastapi import APIRouter, Request
@@ -13,7 +6,7 @@ router = APIRouter(tags=["Status"], prefix="")
 
 
 @router.get("/", operation_id="ping")
-async def ping(request: Request) -> dict:
+async def ping(request: Request) -> str:
     """
     Returns 'OK' if the API is running.
     """

crypticorn/common/scopes.py

@@ -54,7 +54,7 @@ class Scope(StrEnum):
 
     @classmethod
     def admin_scopes(cls) -> list["Scope"]:
-        """Scopes that are only available to admins."""
+        """Scopes that are only available to admins"""
         return [
             cls.WRITE_TRADE_STRATEGIES,
             cls.WRITE_PAY_PRODUCTS,
@@ -64,14 +64,14 @@ class Scope(StrEnum):
 
     @classmethod
     def internal_scopes(cls) -> list["Scope"]:
-        """Scopes that are only available to internal services."""
+        """Scopes that are only available to internal services"""
         return [
             cls.WRITE_TRADE_ACTIONS,
         ]
 
     @classmethod
     def purchaseable_scopes(cls) -> list["Scope"]:
-        """Scopes that can be purchased."""
+        """Scopes that can be purchased"""
         return [
             cls.READ_PREDICTIONS,
         ]

crypticorn/common/urls.py

@@ -3,8 +3,6 @@ from crypticorn.common.enums import ValidateEnumMixin
 
 
 class ApiEnv(StrEnum):
-    """The environment the API is being used with."""
-
     PROD = "prod"
     DEV = "dev"
     LOCAL = "local"
@@ -12,8 +10,6 @@ class ApiEnv(StrEnum):
 
 
 class BaseUrl(StrEnum):
-    """The base URL to connect to the API."""
-
     PROD = "https://api.crypticorn.com"
     DEV = "https://api.crypticorn.dev"
     LOCAL = "http://localhost"
@@ -21,7 +17,6 @@ class BaseUrl(StrEnum):
 
     @classmethod
     def from_env(cls, env: ApiEnv) -> "BaseUrl":
-        """Load the base URL from the API environment."""
         if env == ApiEnv.PROD:
             return cls.PROD
         elif env == ApiEnv.DEV:
@@ -33,14 +28,10 @@ class BaseUrl(StrEnum):
 
 
 class ApiVersion(StrEnum):
-    """Versions to use for the microservice APIs."""
-
     V1 = "v1"
 
 
 class Service(ValidateEnumMixin, StrEnum):
-    """The microservices available to connect to through the API"""
-
     HIVE = "hive"
     KLINES = "klines"
     PAY = "pay"

crypticorn/common/utils.py

@@ -1,14 +1,11 @@
-"""General utility functions and helper methods used across the codebase."""
-
-from typing import Any
+from typing import Any, Union
 from decimal import Decimal
 import string
 import random
-import typing_extensions
-import warnings
+from fastapi import status
+from typing_extensions import deprecated
 
-from crypticorn.common.exceptions import ApiError, HTTPException, ExceptionContent
-from crypticorn.common.warnings import CrypticornDeprecatedSince25
+from crypticorn.common import ApiError, HTTPException, ExceptionContent
 
 
 def throw_if_none(
@@ -36,9 +33,7 @@ def gen_random_id(length: int = 20) -> str:
     return "".join(random.choice(charset) for _ in range(length))
 
 
-@typing_extensions.deprecated(
-    "The `is_equal` method is deprecated; use `math.is_close` instead.", category=None
-)
+@deprecated("Use math.isclose instead. Will be removed in a future version.")
 def is_equal(
     a: float | Decimal,
     b: float | Decimal,
@@ -48,10 +43,6 @@ def is_equal(
     """
     Compare two Decimal numbers for approximate equality.
     """
-    warnings.warn(
-        "The `is_equal` method is deprecated; use `math.is_close` instead.",
-        category=CrypticornDeprecatedSince25,
-    )
     if not isinstance(a, Decimal):
         a = Decimal(str(a))
     if not isinstance(b, Decimal):
@@ -65,12 +56,13 @@ def is_equal(
 
 def optional_import(module_name: str, extra_name: str) -> Any:
     """
-    Tries to import a module. Raises `ImportError` if not found with a message to install the extra dependency.
+    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_name}]"
+            f"Install it with: pip install crypticorn{extra}"
         ) from e

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.admin_api import AdminApi
 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.ohlcv_data_api import OHLCVDataApi
@@ -36,10 +37,17 @@ from crypticorn.klines.client.exceptions import ApiAttributeError
 from crypticorn.klines.client.exceptions import ApiException
 
 # import models into sdk package
+from crypticorn.klines.client.models.api_error_identifier import ApiErrorIdentifier
+from crypticorn.klines.client.models.api_error_level import ApiErrorLevel
+from crypticorn.klines.client.models.api_error_type import ApiErrorType
 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.funding_rate_response import FundingRateResponse
+from crypticorn.klines.client.models.internal_exchange import InternalExchange
+from crypticorn.klines.client.models.log_level import LogLevel
+from crypticorn.klines.client.models.market_type import MarketType
+from crypticorn.klines.client.models.ohlcv import OHLCV
 from crypticorn.klines.client.models.resolution import Resolution
 from crypticorn.klines.client.models.search_symbol import SearchSymbol
 from crypticorn.klines.client.models.sort_direction import SortDirection

crypticorn/klines/client/api/__init__.py

@@ -1,6 +1,7 @@
 # flake8: noqa
 
 # import apis into api package
+from crypticorn.klines.client.api.admin_api import AdminApi
 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.ohlcv_data_api import OHLCVDataApi