crypticorn 2.8.1__py3-none-any.whl → 2.9.0__py3-none-any.whl

crypticorn/__init__.py

@@ -6,9 +6,13 @@ 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/common/__init__.py

@@ -11,5 +11,7 @@ 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,8 +1,9 @@
 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,3 +1,5 @@
+"""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,10 +1,12 @@
+"""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 API error"""
+    """Type of the API error."""
 
     USER_ERROR = "user error"
     """user error by people using our services"""
@@ -17,7 +19,7 @@ class ApiErrorType(ExcludeEnumMixin, StrEnum):
 
 
 class ApiErrorIdentifier(ExcludeEnumMixin, StrEnum):
-    """API error identifiers"""
+    """Unique identifier of the API error."""
 
     ALLOCATION_BELOW_EXPOSURE = "allocation_below_current_exposure"
     ALLOCATION_BELOW_MINIMUM = "allocation_below_min_amount"
@@ -103,7 +105,7 @@ class ApiErrorIdentifier(ExcludeEnumMixin, StrEnum):
 
 
 class ApiErrorLevel(ExcludeEnumMixin, StrEnum):
-    """API error levels"""
+    """Level of the API error."""
 
     ERROR = "error"
     INFO = "info"
@@ -112,7 +114,8 @@ class ApiErrorLevel(ExcludeEnumMixin, StrEnum):
 
 
 class ApiError(ExcludeEnumMixin, Enum, metaclass=ApiErrorFallback):
-    """API error codes. Fallback to UNKNOWN_ERROR for error codes not yet published to PyPI."""
+    # Fallback to UNKNOWN_ERROR for error codes not yet published to PyPI.
+    """Crypticorn API error enumeration."""
 
     ALLOCATION_BELOW_EXPOSURE = (
         ApiErrorIdentifier.ALLOCATION_BELOW_EXPOSURE,
@@ -518,7 +521,7 @@ class ApiError(ExcludeEnumMixin, Enum, metaclass=ApiErrorFallback):
 
 
 class StatusCodeMapper:
-    """Map API errors to HTTP status codes."""
+    """Mapping of API errors to HTTP/Websocket status codes."""
 
     _mapping = {
         # Authentication/Authorization

crypticorn/common/exceptions.py

@@ -1,4 +1,4 @@
-from typing import Optional, Dict, Any, Literal
+from typing import Optional, Dict, Any
 from enum import StrEnum
 from pydantic import BaseModel, Field
 from fastapi import HTTPException as FastAPIHTTPException, Request, FastAPI
@@ -8,16 +8,18 @@ from crypticorn.common import ApiError, ApiErrorIdentifier, ApiErrorType, ApiErr
 import logging
 import json
 
-logger = logging.getLogger("crypticorn")
+_logger = logging.getLogger("crypticorn")
 
 
-class ExceptionType(StrEnum):
+class _ExceptionType(StrEnum):
+    """The protocol the exception is called from"""
+
     HTTP = "http"
     WEBSOCKET = "websocket"
 
 
 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."""
+    """Exception details returned to the client."""
 
     message: Optional[str] = Field(None, description="An additional error message")
     code: ApiErrorIdentifier = Field(..., description="The unique error code")
@@ -28,14 +30,14 @@ 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."""
+    """Exception content used when raising an exception."""
 
     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,
@@ -44,7 +46,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,
@@ -54,14 +56,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 for everything. If the error is not yet implemented, there are fallbacks to avoid errors while testing.
+        The ApiError class is the source of truth. If the error is not yet implemented, there are fallbacks in place.
     """
 
     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
@@ -82,11 +84,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):
-        """This is a helper method to convert an HTTPException to a WebSocketException."""
+        """Helper method to convert an HTTPException to a WebSocketException."""
         return WebSocketException(
             content=http_exception.content,
             headers=http_exception.headers,
@@ -94,46 +96,47 @@ class WebSocketException(HTTPException):
 
 
 async def general_handler(request: Request, exc: Exception) -> JSONResponse:
-    """This is the default exception handler for all exceptions."""
+    """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:
-    """This is the exception handler for all request validation errors."""
+    """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:
-    """This is the exception handler for all response validation errors."""
+    """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:
-    """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)
+    """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
 
 
 def register_exception_handlers(app: FastAPI):

crypticorn/common/logging.py

@@ -1,12 +1,7 @@
 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
@@ -23,6 +18,7 @@ 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:
@@ -38,10 +34,12 @@ 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"))
 
 
@@ -54,7 +52,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)
 
@@ -99,7 +97,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)
@@ -111,7 +109,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
-import logging
+from contextlib import asynccontextmanager
 
 
 def add_cors_middleware(app: "FastAPI"):
@@ -18,6 +18,7 @@ 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,7 +1,9 @@
 from enum import EnumMeta
 import logging
+import warnings
+from crypticorn.common.warnings import CrypticornDeprecatedSince28
 
-logger = logging.getLogger("uvicorn")
+_logger = logging.getLogger("crypticorn")
 
 
 class ValidateEnumMixin:
@@ -35,7 +37,12 @@ class ValidateEnumMixin:
 
 # This Mixin will be removed in a future version. And has no effect from now on
 class ExcludeEnumMixin:
-    """Mixin to exclude enum from OpenAPI schema. We use this to avoid duplicating enums when generating client code from the openapi spec."""
+    """(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,
+    )
 
     @classmethod
     def __get_pydantic_json_schema__(cls, core_schema, handler):
@@ -51,7 +58,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/openapi.py

@@ -0,0 +1,11 @@
+default_tags = [
+        {   
+            "name": "Status",
+            "description": "These endpoints contain status operations.",
+        },
+        {   
+            "name": "Admin",
+            "description": "These endpoints contain debugging and monitoring operations. They require admin scopes.",
+        }
+    ]
+

crypticorn/common/pagination.py

@@ -1,3 +1,5 @@
+"""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

@@ -10,8 +10,9 @@ import importlib.metadata
 import threading
 import time
 import psutil
+import re
 from fastapi import APIRouter, Query
-from typing import Literal, Union
+from typing import Literal
 from crypticorn.common.logging import LogLevel
 import logging
 
@@ -86,13 +87,19 @@ def get_container_limits() -> dict:
 def list_installed_packages(
     include: list[str] = Query(
         default=None,
-        description="List of dependencies to include in the response. If not provided, all installed packages will be returned.",
+        description="List of regex patterns to match against package names. If not provided, all installed packages will be returned.",
     )
-) -> list:
-    """Return a list of installed packages and versions."""
+) -> dict[str, str]:
+    """Return a list of installed packages and versions.
+    
+    The include parameter accepts regex patterns to match against package names.
+    For example:
+    - crypticorn.* will match all packages starting with 'crypticorn'
+    - .*tic.* will match all packages containing 'tic' in their name
+    """
     packages = {
         dist.metadata["Name"]: dist.version
         for dist in importlib.metadata.distributions()
-        if include is None or dist.metadata["Name"] in include
+        if include is None or any(re.match(pattern, dist.metadata["Name"]) for pattern in include)
     }
     return dict(sorted(packages.items()))

crypticorn/common/router/status_router.py

@@ -1,3 +1,10 @@
+"""
+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
@@ -6,7 +13,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,6 +3,8 @@ from crypticorn.common.enums import ValidateEnumMixin
 
 
 class ApiEnv(StrEnum):
+    """The environment the API is being used with."""
+
     PROD = "prod"
     DEV = "dev"
     LOCAL = "local"
@@ -10,6 +12,8 @@ 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"
@@ -17,6 +21,7 @@ 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:
@@ -28,10 +33,14 @@ 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,11 +1,14 @@
-from typing import Any, Union
+"""General utility functions and helper methods used across the codebase."""
+
+from typing import Any
 from decimal import Decimal
 import string
 import random
-from fastapi import status
-from typing_extensions import deprecated
+import typing_extensions
+import warnings
 
-from crypticorn.common import ApiError, HTTPException, ExceptionContent
+from crypticorn.common.exceptions import ApiError, HTTPException, ExceptionContent
+from crypticorn.common.warnings import CrypticornDeprecatedSince25
 
 
 def throw_if_none(
@@ -33,7 +36,9 @@ 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.")
+@typing_extensions.deprecated(
+    "The `is_equal` method is deprecated; use `math.is_close` instead.", category=None
+)
 def is_equal(
     a: float | Decimal,
     b: float | Decimal,
@@ -43,6 +48,10 @@ 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):
@@ -56,13 +65,12 @@ def is_equal(
 
 def optional_import(module_name: str, extra_name: str) -> Any:
     """
-    Import a module optionally.
+    Tries to import a module. Raises `ImportError` if not found with a message to install the extra dependency.
     """
     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}"
+            f"Install it with: pip install crypticorn[{extra_name}]"
         ) from e

crypticorn/common/warnings.py

@@ -0,0 +1,63 @@
+"""Crypticorn-specific warnings."""
+
+from __future__ import annotations
+
+
+class CrypticornDeprecationWarning(DeprecationWarning):
+    """A Crypticorn specific deprecation warning.
+
+    This warning is raised when using deprecated functionality in Crypticorn. It provides information on when the
+    deprecation was introduced and the expected version in which the corresponding functionality will be removed.
+
+    Attributes:
+        message: Description of the warning.
+        since: Crypticorn version in what the deprecation was introduced.
+        expected_removal: Crypticorn version in what the corresponding functionality expected to be removed.
+    """
+
+    message: str
+    since: tuple[int, int]
+    expected_removal: tuple[int, int]
+
+    def __init__(
+        self,
+        message: str,
+        *args: object,
+        since: tuple[int, int],
+        expected_removal: tuple[int, int] | None = None,
+    ) -> None:
+        super().__init__(message, *args)
+        self.message = message.rstrip(".")
+        self.since = since
+        self.expected_removal = (
+            expected_removal if expected_removal is not None else (since[0] + 1, 0)
+        )
+
+    def __str__(self) -> str:
+        message = (
+            f"{self.message}. Deprecated in Crypticorn v{self.since[0]}.{self.since[1]}"
+            f" to be removed in v{self.expected_removal[0]}.{self.expected_removal[1]}."
+        )
+        return message
+
+
+class CrypticornDeprecatedSince25(CrypticornDeprecationWarning):
+    """A specific `CrypticornDeprecationWarning` subclass defining functionality deprecated since Crypticorn 2.5."""
+
+    def __init__(self, message: str, *args: object) -> None:
+        super().__init__(message, *args, since=(2, 5), expected_removal=(3, 0))
+
+
+class CrypticornDeprecatedSince28(CrypticornDeprecationWarning):
+    """A specific `CrypticornDeprecationWarning` subclass defining functionality deprecated since Crypticorn 2.8."""
+
+    def __init__(self, message: str, *args: object) -> None:
+        super().__init__(message, *args, since=(2, 8), expected_removal=(3, 0))
+
+
+class CrypticornExperimentalWarning(Warning):
+    """A Crypticorn specific experimental functionality warning.
+
+    This warning is raised when using experimental functionality in Crypticorn.
+    It is raised to warn users that the functionality may change or be removed in future versions of Crypticorn.
+    """

crypticorn/metrics/client/api/admin_api.py

@@ -16,8 +16,8 @@ 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, StrictInt, StrictStr, field_validator
-from typing import Any, Dict, List, Optional
+from pydantic import Field, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, Dict, List, Optional, Union
 from typing_extensions import Annotated
 from crypticorn.metrics.client.models.log_level import LogLevel
 
@@ -248,7 +248,7 @@ class AdminApi:
             )
 
         # authentication setting
-        _auth_settings: List[str] = []
+        _auth_settings: List[str] = ["APIKeyHeader", "HTTPBearer"]
 
         return self.api_client.param_serialize(
             method="GET",
@@ -509,7 +509,7 @@ class AdminApi:
             )
 
         # authentication setting
-        _auth_settings: List[str] = []
+        _auth_settings: List[str] = ["APIKeyHeader", "HTTPBearer"]
 
         return self.api_client.param_serialize(
             method="GET",
@@ -541,9 +541,9 @@ class AdminApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> LogLevel:
-        """Get Logging Level
+        """(Deprecated) Get Logging Level
 
-        Get the log level of the server logger.
+        Get the log level of the server logger. Will be removed in a future release.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -566,6 +566,7 @@ class AdminApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """  # noqa: E501
+        warnings.warn("GET /admin/log-level is deprecated.", DeprecationWarning)
 
         _param = self._get_log_level_serialize(
             _request_auth=_request_auth,
@@ -601,9 +602,9 @@ class AdminApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[LogLevel]:
-        """Get Logging Level
+        """(Deprecated) Get Logging Level
 
-        Get the log level of the server logger.
+        Get the log level of the server logger. Will be removed in a future release.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -626,6 +627,7 @@ class AdminApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """  # noqa: E501
+        warnings.warn("GET /admin/log-level is deprecated.", DeprecationWarning)
 
         _param = self._get_log_level_serialize(
             _request_auth=_request_auth,
@@ -661,9 +663,9 @@ class AdminApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Get Logging Level
+        """(Deprecated) Get Logging Level
 
-        Get the log level of the server logger.
+        Get the log level of the server logger. Will be removed in a future release.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -686,6 +688,7 @@ class AdminApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """  # noqa: E501
+        warnings.warn("GET /admin/log-level is deprecated.", DeprecationWarning)
 
         _param = self._get_log_level_serialize(
             _request_auth=_request_auth,
@@ -736,7 +739,7 @@ class AdminApi:
             )
 
         # authentication setting
-        _auth_settings: List[str] = []
+        _auth_settings: List[str] = ["APIKeyHeader", "HTTPBearer"]
 
         return self.api_client.param_serialize(
             method="GET",
@@ -767,7 +770,7 @@ class AdminApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> int:
+    ) -> float:
         """Get Memory Usage
 
         Resident Set Size (RSS) in MB — the actual memory used by the process in RAM. Represents the physical memory footprint. Important for monitoring real usage.
@@ -802,7 +805,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "int",
+            "200": "float",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -827,7 +830,7 @@ class AdminApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[int]:
+    ) -> ApiResponse[float]:
         """Get Memory Usage
 
         Resident Set Size (RSS) in MB — the actual memory used by the process in RAM. Represents the physical memory footprint. Important for monitoring real usage.
@@ -862,7 +865,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "int",
+            "200": "float",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -922,7 +925,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "int",
+            "200": "float",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -963,7 +966,7 @@ class AdminApi:
             )
 
         # authentication setting
-        _auth_settings: List[str] = []
+        _auth_settings: List[str] = ["APIKeyHeader", "HTTPBearer"]
 
         return self.api_client.param_serialize(
             method="GET",
@@ -1190,7 +1193,7 @@ class AdminApi:
             )
 
         # authentication setting
-        _auth_settings: List[str] = []
+        _auth_settings: List[str] = ["APIKeyHeader", "HTTPBearer"]
 
         return self.api_client.param_serialize(
             method="GET",
@@ -1434,7 +1437,7 @@ class AdminApi:
             )
 
         # authentication setting
-        _auth_settings: List[str] = []
+        _auth_settings: List[str] = ["APIKeyHeader", "HTTPBearer"]
 
         return self.api_client.param_serialize(
             method="GET",

crypticorn/metrics/client/api/status_api.py

@@ -17,7 +17,7 @@ from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
 from pydantic import StrictStr, field_validator
-from typing import Optional
+from typing import Any, Dict, Optional
 
 from crypticorn.metrics.client.api_client import ApiClient, RequestSerialized
 from crypticorn.metrics.client.api_response import ApiResponse
@@ -294,7 +294,7 @@ class StatusApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> str:
+    ) -> Dict[str, object]:
         """Ping
 
         Returns 'OK' if the API is running.
@@ -329,7 +329,7 @@ class StatusApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "str",
+            "200": "Dict[str, object]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -354,7 +354,7 @@ class StatusApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[str]:
+    ) -> ApiResponse[Dict[str, object]]:
         """Ping
 
         Returns 'OK' if the API is running.
@@ -389,7 +389,7 @@ class StatusApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "str",
+            "200": "Dict[str, object]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -449,7 +449,7 @@ class StatusApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "str",
+            "200": "Dict[str, object]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout

crypticorn/metrics/client/configuration.py

@@ -215,7 +215,9 @@ class Configuration:
         debug: Optional[bool] = None,
     ) -> None:
         """Constructor"""
-        self._base_path = "http://localhost/v1/metrics" if host is None else host
+        self._base_path = (
+            "https://api.crypticorn.dev/v1/metrics" if host is None else host
+        )
         """Default Base url
         """
         self.server_index = 0 if server_index is None and host is None else server_index
@@ -557,7 +559,7 @@ class Configuration:
         """
         return [
             {
-                "url": "http://localhost/v1/metrics",
+                "url": "https://api.crypticorn.dev/v1/metrics",
                 "description": "No description provided",
             }
         ]

{crypticorn-2.8.1.dist-info → crypticorn-2.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.8.1
+Version: 2.9.0
 Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
 License: MIT
@@ -43,6 +43,7 @@ Requires-Dist: isort; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: openapi-generator-cli<8.0.0,>=7.12.0; extra == "dev"
 Requires-Dist: pdoc==15.0.3; extra == "dev"
+Requires-Dist: python-semantic-release==9.21.0; extra == "dev"
 Provides-Extra: test
 Requires-Dist: pytest==8.3.5; extra == "test"
 Requires-Dist: pytest-asyncio==0.26.0; extra == "test"

{crypticorn-2.8.1.dist-info → crypticorn-2.9.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-crypticorn/__init__.py,sha256=IWYO6MWcpNmgkH05xEywxcIjcegWuSo5cpNIDTRcpC8,303
+crypticorn/__init__.py,sha256=ctrwe5CQtYhnetHYPgSmC0CIHa4xbDsLZvpY38tfEow,423
 crypticorn/client.py,sha256=XcJhgMoNSFQZJU3AoYuvxRMh-HPBPBlugKMpGSHxbIE,4700
 crypticorn/auth/__init__.py,sha256=JAl1tBLK9pYLr_-YKaj581c-c94PWLoqnatTIVAVvMM,81
 crypticorn/auth/main.py,sha256=j8eRGN2gUWyeOCnWnUPe3mCAfaidGnOMnZRiSQy-yzM,720
@@ -63,22 +63,24 @@ crypticorn/cli/templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 crypticorn/cli/templates/auth.py,sha256=Q1TxlA7qzhjvrqp1xz1aV2vGnj3DKFNN-VSl3o0B-dI,983
 crypticorn/cli/templates/dependabot.yml,sha256=ct5ieB8KAV1KLzoYKUNm6dZ9wKG_P_JQHgRjZUfT54w,861
 crypticorn/cli/templates/ruff.yml,sha256=gWicFFTzC4nToSmRkIIGipos8CZ447YG0kebBCJhtJE,319
-crypticorn/common/__init__.py,sha256=29n5tUr9-yjjJ8sjkbMrwq7pDKZ2Z1qz1bR1msGJDkA,671
-crypticorn/common/ansi_colors.py,sha256=_ja-pxo0dUAT4WFZuYkOLliWA7LqTjvcew9dJUcgugU,1174
-crypticorn/common/auth.py,sha256=GIb9MikQsSxqz-K5rDIOroP5mFoTgQqwByTGO5JqcdM,8713
+crypticorn/common/__init__.py,sha256=DXEuUU_kaLBSBcvpiFie_ROuK5XEZuTMIfsg-BZE0iE,752
+crypticorn/common/ansi_colors.py,sha256=ts49UtfTy-c0uvlGwb3wE-jE_GbXvSBSfzwrDlNi0HE,1331
+crypticorn/common/auth.py,sha256=5wgApDw5x7dI-IWU9tX_gih-gMozi7Y5Tgpen-A9fbo,8713
 crypticorn/common/decorators.py,sha256=pmnGYCIrLv59wZkDbvPyK9NJmgPJWW74LXTdIWSjOkY,1063
-crypticorn/common/enums.py,sha256=RitDVqlG_HTe6tHT6bWusZNFCeYk1eQvJVH-7x3_Zlg,668
-crypticorn/common/errors.py,sha256=8jxZ2lLn_NoFKKq6n2JwKPsR0dA2vkGnbXDfEK6ndH0,27851
-crypticorn/common/exceptions.py,sha256=9ftvKoMFP9rNvaYhCKDgbJXwTYrBlReMmFwL3RzZJYQ,6203
-crypticorn/common/logging.py,sha256=xF7j4-rGj6ALlz5JwbMi4oEeyfI6VKDh3GlR3kCe3hc,4295
-crypticorn/common/middleware.py,sha256=YF0_tTjQekZkb6ip3xsqy04JCI4S8011CiSL3helU2E,962
-crypticorn/common/mixins.py,sha256=o-VONtAS_nHH-OPCFXox6kdX_Xdn1g37uTtkLqij-6U,1722
-crypticorn/common/pagination.py,sha256=c07jrMNrBaNTmgx4sppdP7ND4RNT7NBqBXWvofazIlE,2251
-crypticorn/common/scopes.py,sha256=ofJ5FDf30wab572XvDzAXVKBIUWa3shScAmzNrJsWqQ,2453
-crypticorn/common/urls.py,sha256=3Gf1NU1XQYcOTjcdztG3bDAE98FVbgTK2QXzUe7tFVQ,878
-crypticorn/common/utils.py,sha256=Kz2-I96MKIGKM18PHQ77VbKHLMGUvZG_jjj7xpQed8k,2138
-crypticorn/common/router/admin_router.py,sha256=_Uvpkrg6daNiAdfr_2rtBlcCq8OvHy04Me12VRWdh4Y,3434
-crypticorn/common/router/status_router.py,sha256=_PPeYi8ps2Og-oJCnf9O7heaCYHq3oStF0_He0D_tZo,642
+crypticorn/common/enums.py,sha256=8iPG1UFtU50HKytOrubYJsFJ_isMY5z69U2mezXA-NE,765
+crypticorn/common/errors.py,sha256=E7H8DVUP4E4uu-ze9v7aJBrfV7ODgbFBXJeyVSXbdVo,28041
+crypticorn/common/exceptions.py,sha256=iq_VFkZ4jr_7BeEjDwlmHyRYPLIYN98-MJGJrxe2OqM,6036
+crypticorn/common/logging.py,sha256=bpWT3ip8CM5tf_jKECJjwrVVf5GYcRjfo-CPb47gISU,4346
+crypticorn/common/middleware.py,sha256=O7XiXPimNYUhF9QTv6yFUTVlb91-SK-3CfTrWMNP6Ck,1011
+crypticorn/common/mixins.py,sha256=NoZL1kXgSb4oVOGNWPqPwCcVZYjHzlsyL80bz6Xxlzg,2002
+crypticorn/common/openapi.py,sha256=Hppim3bLIy_uDixuC3ZPGCsxwk9WU5R45ua8XqZFatg,321
+crypticorn/common/pagination.py,sha256=BYMNB4JUW9eeiTw1q3CyHXaT_-hk_BrSXAOqvif08Ek,2334
+crypticorn/common/scopes.py,sha256=TsSzMFHQAJ45CwhSrU3uRPHyHHjrCgPdJhAyjxY6b2Q,2456
+crypticorn/common/urls.py,sha256=qJHxdkpwQR1iPLSPMYVoobnLNSsQoKVV5SsRng4dZYs,1161
+crypticorn/common/utils.py,sha256=N4h-FtojufTuc4IBU7TeuSOygFvErpgZDrwl4epGmvw,2503
+crypticorn/common/warnings.py,sha256=bIfMLbKaCntMV88rTnoWgV6SZ9FJvo_adXv3yFW1rqg,2395
+crypticorn/common/router/admin_router.py,sha256=G-dtyvgLnsPpWSB4Gqkw2_m9w2bCMM-bs--sDWe63AY,3736
+crypticorn/common/router/status_router.py,sha256=it6kfvx_Pn4Rv06fmViwhwr-m6f4WuSgcZwc6VTaMz4,868
 crypticorn/hive/__init__.py,sha256=hRfTlEzEql4msytdUC_04vfaHzVKG5CGZle1M-9QFgY,81
 crypticorn/hive/main.py,sha256=eoo5bTmbfS94zuYHDkD20orNANESYuTURHQNw3pIEvQ,2875
 crypticorn/hive/utils.py,sha256=5T2GYnIFazXgAdUlO03xWqcMWhWkM82cfWvwsO8geHE,2040
@@ -159,19 +161,19 @@ crypticorn/metrics/main.py,sha256=I4KZ-46ro6I6-EWf3p1BZV-8Iryorr8pRUZhv3yXzXI,35
 crypticorn/metrics/client/__init__.py,sha256=zp5tyfddEBfFrCqp9YEAwObC60lZ0GnqO3dvsAOt1zE,2530
 crypticorn/metrics/client/api_client.py,sha256=pGWJuO-mgxlUdhJGwkScf7CviGzjDrmUAiU0LXasQY4,26934
 crypticorn/metrics/client/api_response.py,sha256=WhxwYDSMm6wPixp9CegO8dJzjFxDz3JF1yCq9s0ZqKE,639
-crypticorn/metrics/client/configuration.py,sha256=wA1hBWEINMM_AlZg-DAv1AelmkjBERB5d2gA66aEwSM,19158
+crypticorn/metrics/client/configuration.py,sha256=BQNgtkCNhI3uB8qCV54TMf85b3sFzQYvXGMbhar5KSM,19202
 crypticorn/metrics/client/exceptions.py,sha256=UegnYftFlQDXAQv8BmD20yRzTtWpjTHcuOymTBWmgeE,6421
 crypticorn/metrics/client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 crypticorn/metrics/client/rest.py,sha256=pWeYnpTfTV7L5U6Kli3b7i8VrmqdG8sskqSnTHPIoQo,7025
 crypticorn/metrics/client/api/__init__.py,sha256=nNmEy9XBH8jQboMzedrzeGl8OVuDo_iylCaFw4Fgysg,649
-crypticorn/metrics/client/api/admin_api.py,sha256=8JGUN0w-bIcENKLJVgBvkVgAlDIRqilTTaF8ulUCPok,58540
+crypticorn/metrics/client/api/admin_api.py,sha256=QAfVE4Ag2QAsu1imyK-ylrQDxQX4-Ue10H7pxAfGPb0,59131
 crypticorn/metrics/client/api/exchanges_api.py,sha256=BZiJH8hxxSnI9SXydgErM6gzvIR-t9vNXbh9fFotpQQ,40455
 crypticorn/metrics/client/api/indicators_api.py,sha256=gltFmv_EorYbeWMnp-N0QkgdVKrkvi1iOZUP_ewkXZ0,26748
 crypticorn/metrics/client/api/logs_api.py,sha256=lDOixn5hn3DWc6HjExWtKZfy7U4NfcSLsO1bNFrx4GE,13550
 crypticorn/metrics/client/api/marketcap_api.py,sha256=28lQlBJh5hdW7fULJl55bAJy_HWZWEdouds63YJIwAQ,51106
 crypticorn/metrics/client/api/markets_api.py,sha256=NbPtD5bQK_Nt73hlVd6cd1pAZ7HO1QQgNl_abNoN00s,14739
 crypticorn/metrics/client/api/quote_currencies_api.py,sha256=H4c3zOp5eTTUrRMlMH-H8aIIBpV4Ioj8c65UUt_BEuE,11259
-crypticorn/metrics/client/api/status_api.py,sha256=_Ou_EGmjPyv32G-S4QKfRemdpGG6FUsgOkbGDfYaFp0,19633
+crypticorn/metrics/client/api/status_api.py,sha256=hxQf-22CurM-1TQygsYeYiL8CVhFe9cCPbDkX0zLvfg,19714
 crypticorn/metrics/client/api/tokens_api.py,sha256=x5a-YAeAgFJm-pN4K3-lOM-WPVYAxoBr-AYb-oxhysM,19522
 crypticorn/metrics/client/models/__init__.py,sha256=Voa1tj-CTpvzF6UmGJf0h0zFqG-7wFV8TSwH_lst0WY,1285
 crypticorn/metrics/client/models/api_error_identifier.py,sha256=HrL78MgQ0NbWv8CJhl6Zbp3QSIK2xO8lAZy5y6M8NCk,4948
@@ -255,8 +257,8 @@ crypticorn/trade/client/models/strategy_model_input.py,sha256=ala19jARyfA5ysys5D
 crypticorn/trade/client/models/strategy_model_output.py,sha256=2o2lhbgUSTznowpMLEHF1Ex9TG9oRmzlCIb-gXqo7_s,5643
 crypticorn/trade/client/models/tpsl.py,sha256=C2KgTIZs-a8W4msdaXgBKJcwtA-o5wR4rBauRP-iQxU,4317
 crypticorn/trade/client/models/trading_action_type.py,sha256=pGq_TFLMPfYFizYP-xKgEC1ZF4U3lGdJYoGa_ZH2x-Q,769
-crypticorn-2.8.1.dist-info/METADATA,sha256=03ryK64UR_9PrQWtB60H8y896n-YKmmb99gW2DO9gJU,8140
-crypticorn-2.8.1.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-crypticorn-2.8.1.dist-info/entry_points.txt,sha256=d_xHsGvUTebPveVUK0SrpDFQ5ZRSjlI7lNCc11sn2PM,59
-crypticorn-2.8.1.dist-info/top_level.txt,sha256=EP3NY216qIBYfmvGl0L2Zc9ItP0DjGSkiYqd9xJwGcM,11
-crypticorn-2.8.1.dist-info/RECORD,,
+crypticorn-2.9.0.dist-info/METADATA,sha256=x3EAb8VtrmVvAz4cMxg_D1qM-sS5Jum2VwKTFF7pYcE,8203
+crypticorn-2.9.0.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
+crypticorn-2.9.0.dist-info/entry_points.txt,sha256=d_xHsGvUTebPveVUK0SrpDFQ5ZRSjlI7lNCc11sn2PM,59
+crypticorn-2.9.0.dist-info/top_level.txt,sha256=EP3NY216qIBYfmvGl0L2Zc9ItP0DjGSkiYqd9xJwGcM,11
+crypticorn-2.9.0.dist-info/RECORD,,