crypticorn 2.7.5__py3-none-any.whl → 2.8.0rc1__py3-none-any.whl

crypticorn/common/__init__.py

@@ -8,4 +8,7 @@ from crypticorn.common.enums import *
 from crypticorn.common.utils import *
 from crypticorn.common.exceptions import *
 from crypticorn.common.pagination import *
-from crypticorn.common.status_router import router as status_router
+from crypticorn.common.logging import *
+from crypticorn.common.ansi_colors 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

@@ -0,0 +1,40 @@
+from enum import StrEnum
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    pass
+
+
+class AnsiColors(StrEnum):
+    # Regular Text Colors
+    BLACK = "\033[30m"  # black
+    RED = "\033[31m"  # red
+    GREEN = "\033[32m"  # green
+    YELLOW = "\033[33m"  # yellow
+    BLUE = "\033[34m"  # blue
+    MAGENTA = "\033[35m"  # magenta
+    CYAN = "\033[36m"  # cyan
+    WHITE = "\033[37m"  # white
+
+    # Bright Text Colors
+    BLACK_BRIGHT = "\033[90m"  # black_bright
+    RED_BRIGHT = "\033[91m"  # red_bright
+    GREEN_BRIGHT = "\033[92m"  # green_bright
+    YELLOW_BRIGHT = "\033[93m"  # yellow_bright
+    BLUE_BRIGHT = "\033[94m"  # blue_bright
+    MAGENTA_BRIGHT = "\033[95m"  # magenta_bright
+    CYAN_BRIGHT = "\033[96m"  # cyan_bright
+    WHITE_BRIGHT = "\033[97m"  # white_bright
+
+    # Bold Text Colors
+    BLACK_BOLD = "\033[1;30m"  # black_bold
+    RED_BOLD = "\033[1;31m"  # red_bold
+    GREEN_BOLD = "\033[1;32m"  # green_bold
+    YELLOW_BOLD = "\033[1;33m"  # yellow_bold
+    BLUE_BOLD = "\033[1;34m"  # blue_bold
+    MAGENTA_BOLD = "\033[1;35m"  # magenta_bold
+    CYAN_BOLD = "\033[1;36m"  # cyan_bold
+    WHITE_BOLD = "\033[1;37m"  # white_bold
+
+    # Reset Color
+    RESET = "\033[0m"

crypticorn/common/auth.py

@@ -75,7 +75,7 @@ class AuthHandler:
             raise HTTPException(
                 content=ExceptionContent(
                     error=ApiError.INSUFFICIENT_SCOPES,
-                    message="Insufficient scopes to access this resource",
+                    message="Insufficient scopes to access this resource (required: " + ", ".join(api_scopes) + ")",
                 ),
             )
 

crypticorn/common/exceptions.py

@@ -9,6 +9,7 @@ import logging
 
 logger = logging.getLogger(__name__)
 
+
 class ExceptionType(StrEnum):
     HTTP = "http"
     WEBSOCKET = "websocket"
@@ -91,34 +92,37 @@ class WebSocketException(HTTPException):
         )
 
 
-async def general_handler(request: Request, exc: Exception):
+async def general_handler(request: Request, exc: Exception) -> JSONResponse:
     """This is the default exception handler for all exceptions."""
-    body = ExceptionContent(message=str(exc), error=ApiError.UNKNOWN_ERROR).enrich()
-    logger.error(f"Unknown error: {body.detail}")
-    return JSONResponse(
-        status_code=body.status_code, content=HTTPException(content=body).detail
+    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: {res}")
+    return res
 
 
-async def request_validation_handler(request: Request, exc: RequestValidationError):
+async def request_validation_handler(request: Request, exc: RequestValidationError) -> JSONResponse:
     """This is the exception handler for all request validation errors."""
-    body = ExceptionContent(message=str(exc), error=ApiError.INVALID_DATA_REQUEST).enrich()
-    logger.error(f"Request validation error: {body.detail}")
-    return JSONResponse(
-        status_code=body.status_code, content=HTTPException(content=body).detail
+    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: {res}")
+    return res
 
 
-async def response_validation_handler(request: Request, exc: ResponseValidationError):
+async def response_validation_handler(request: Request, exc: ResponseValidationError) -> JSONResponse:
     """This is the exception handler for all response validation errors."""
-    body = ExceptionContent(message=str(exc), error=ApiError.INVALID_DATA_RESPONSE).enrich()
-    logger.error(f"Response validation error: {body.detail}")
-    return JSONResponse(
-        status_code=body.status_code, content=HTTPException(content=body).detail
+    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: {res}")
+    return res
 
 
-async def http_handler(request: Request, exc: HTTPException):
+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)

crypticorn/common/logging.py

@@ -0,0 +1,103 @@
+# shared_logger.py
+import logging
+from logging import _nameToLevel, _levelToName
+import sys
+from contextvars import ContextVar
+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
+from datetime import datetime
+
+class LogLevel(ValidateEnumMixin, StrEnum):
+    DEBUG = "DEBUG"
+    INFO = "INFO"
+    WARNING = "WARNING"
+    ERROR = "ERROR"
+    CRITICAL = "CRITICAL"
+
+    @classmethod
+    def get_color(cls, level: str) -> str:
+        if level == cls.DEBUG:
+            return C.GREEN_BRIGHT
+        elif level == cls.INFO:
+            return C.BLUE_BRIGHT
+        elif level == cls.WARNING:
+            return C.YELLOW_BRIGHT
+        elif level == cls.ERROR:
+            return C.RED_BRIGHT
+        elif level == cls.CRITICAL:
+            return C.RED_BOLD
+        else:
+            return C.RESET
+
+    @staticmethod
+    def get_level(level: "LogLevel") -> int:
+        return _nameToLevel.get(level, logging.INFO)
+
+    @staticmethod
+    def get_name(level: int) -> "LogLevel":
+        return LogLevel(_levelToName.get(level, "INFO"))
+
+
+_LOGFORMAT = (
+    f"{C.CYAN_BOLD}%(asctime)s{C.RESET} - "
+    f"{C.GREEN_BOLD}%(name)s{C.RESET} - "
+    f"%(levelcolor)s%(levelname)s{C.RESET} - "
+    f"%(message)s"
+)
+_PLAIN_LOGFORMAT = (
+    "%(asctime)s - " "%(name)s - " "%(levelname)s - " "%(message)s"
+)
+_DATEFMT = "%Y-%m-%d %H:%M:%S.%f:"
+
+
+class CustomFormatter(logging.Formatter):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    def format(self, record):
+        color = LogLevel.get_color(record.levelname)
+        record.levelcolor = color
+        return super().format(record)
+
+    def formatTime(self, record, datefmt=_DATEFMT):
+        dt = datetime.fromtimestamp(record.created)
+        s = dt.strftime(datefmt)
+        return s[:-3]  # Trim last 3 digits to get milliseconds
+
+def get_logger(
+    name: str, fmt: str = _LOGFORMAT, datefmt: str = _DATEFMT,
+    stdout_level: int = logging.INFO,
+    file_level: int = logging.INFO,
+    log_file: str = None,
+    filters: list[logging.Filter] = [],
+) -> logging.Logger:
+    """Returns crypticorn logger instance."""
+    logger = logging.getLogger(name)
+
+    if logger.handlers: # clear existing handlers to avoid duplicates
+        logger.handlers.clear()
+
+    logger.setLevel(min(stdout_level, file_level)) # set to most verbose level
+
+    # Configure stdout handler
+    stdout_handler = logging.StreamHandler(sys.stdout)
+    stdout_handler.setLevel(stdout_level)
+    stdout_handler.setFormatter(CustomFormatter(fmt=fmt, datefmt=datefmt))
+    for filter in filters:
+        stdout_handler.addFilter(filter)
+    logger.addHandler(stdout_handler)
+
+    # Configure file handler
+    if log_file:
+        os.makedirs(os.path.dirname(log_file), exist_ok=True)
+        file_handler = logging.RotatingFileHandler(log_file, maxBytes=10*1024*1024, backupCount=5)
+        file_handler.setLevel(file_level)
+        file_handler.setFormatter(CustomFormatter(fmt=fmt, datefmt=datefmt))
+        for filter in filters:
+            file_handler.addFilter(filter)
+        logger.addHandler(file_handler)
+
+    return logger

crypticorn/common/router/admin_router.py

@@ -0,0 +1,96 @@
+"""
+This module contains the admin router for the API.
+It provides endpoints for monitoring the server and getting information about the environment.
+ONLY ALLOW ACCESS TO THIS ROUTER WITH ADMIN SCOPES.
+>>> app.include_router(admin_router, dependencies=[Security(auth_handler.combined_auth, scopes=[Scope.WRITE_LOGS])])
+"""
+
+import os
+import sys
+import pkg_resources
+import threading
+import time
+import json
+import psutil
+from fastapi import APIRouter, HTTPException, Body, Query
+from typing import Literal, Union
+from dotenv import dotenv_values
+from crypticorn.common.logging import LogLevel
+import logging
+
+router = APIRouter(tags=["Admin"], prefix="/admin")
+
+START_TIME = time.time()
+
+@router.get("/log-level", status_code=200, operation_id="getLogLevel")
+async def get_logging_level() -> LogLevel:
+    """
+    Get the log level of the server logger.
+    """
+    return LogLevel.get_name(logging.getLogger().level)
+
+@router.get("/uptime", operation_id="getUptime", status_code=200)
+def get_uptime(
+    type: Literal["seconds", "human"] = "seconds"
+) -> Union[int, str]:
+    """Return the server uptime in seconds or human-readable form."""
+    uptime_seconds = int(time.time() - START_TIME)
+    if type == "seconds":
+        return uptime_seconds
+    elif type == "human":
+        return time.strftime("%H:%M:%S", time.gmtime(uptime_seconds))
+
+
+@router.get("/memory", operation_id="getMemoryUsage", status_code=200)
+def get_memory_usage() -> int:
+    """
+    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.
+    """
+    process = psutil.Process(os.getpid())
+    mem_info = process.memory_info()
+    return round(mem_info.rss / (1024 * 1024), 2)
+
+
+@router.get("/threads", operation_id="getThreads", status_code=200)
+def get_threads() -> dict:
+    """Return count and names of active threads."""
+    threads = threading.enumerate()
+    return {
+        "count": len(threads),
+        "threads": [t.name for t in threads],
+    }
+
+
+@router.get("/limits", operation_id="getContainerLimits", status_code=200)
+def get_container_limits() -> dict:
+    """Return container resource limits from cgroup."""
+    limits = {}
+    try:
+        with open("/sys/fs/cgroup/memory/memory.limit_in_bytes") as f:
+            limits["memory_limit_MB"] = int(f.read().strip()) / 1024 / 1024
+    except Exception:
+        limits["memory_limit_MB"] = "N/A"
+
+    try:
+        with open("/sys/fs/cgroup/cpu/cpu.cfs_quota_us") as f1, open("/sys/fs/cgroup/cpu/cpu.cfs_period_us") as f2:
+            quota = int(f1.read().strip())
+            period = int(f2.read().strip())
+            limits["cpu_limit_cores"] = quota / period if quota > 0 else "N/A"
+    except Exception:
+        limits["cpu_limit_cores"] = "N/A"
+
+    return limits
+
+
+@router.get("/dependencies", operation_id="getDependencies", status_code=200)
+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."
+    )
+) -> 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)),
+    )

crypticorn/common/{status_router.py → router/status_router.py}

@@ -22,23 +22,3 @@ async def time(type: Literal["iso", "unix"] = "iso") -> str:
         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("crypticorn")
-    except importlib.metadata.PackageNotFoundError:
-        crypticorn_version = "not installed"
-    return {
-        "crypticorn": f"v{crypticorn_version}",
-        "environment": os.getenv("API_ENV", "not set"),
-    }

crypticorn/common/scopes.py

@@ -8,6 +8,9 @@ class Scope(StrEnum):
 
     # If you update anything here, also update the scopes in the auth-service repository
 
+    WRITE_ADMIN = "write:admin"
+    READ_ADMIN = "read:admin"
+
     # Scopes that can be purchased - these actually exist in the jwt token
     READ_PREDICTIONS = "read:predictions"
 
@@ -55,6 +58,8 @@ class Scope(StrEnum):
         return [
             cls.WRITE_TRADE_STRATEGIES,
             cls.WRITE_PAY_PRODUCTS,
+            cls.WRITE_ADMIN,
+            cls.READ_ADMIN,
         ]
 
     @classmethod

{crypticorn-2.7.5.dist-info → crypticorn-2.8.0rc1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.7.5
+Version: 2.8.0rc1
 Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
 License: MIT

{crypticorn-2.7.5.dist-info → crypticorn-2.8.0rc1.dist-info}/RECORD

@@ -63,18 +63,21 @@ 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=42ajAXlz0LDBb1AFyX8xvwpp1MB_YrvqutFDkLthUQM,464
-crypticorn/common/auth.py,sha256=60SRXlW72VJO8rGzCiemWmzGu8tXDqWr0wt9EM6p8aI,8631
+crypticorn/common/__init__.py,sha256=FkOmpnrSPtSyz5CoWWqIEslEF601vb_3H46ZUwwEtAQ,628
+crypticorn/common/ansi_colors.py,sha256=WqyRMlu3tJj5e-c3hEpa0dupNVZhzRmQcxJgRWSyJ_k,1202
+crypticorn/common/auth.py,sha256=6oJ26t0N2Msup-okC2iFhpHz9ZeaGnQZ5zaCODIsN_k,8673
 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=FOxScGTnAoiBkpC5lccQ6_b1jIPcWxawZvR_H2KBCNY,5953
+crypticorn/common/exceptions.py,sha256=tOg8WjJXTtDcqZjokwk4QD5cQtXq5-2gAbvbHENJTng,6050
+crypticorn/common/logging.py,sha256=ncy4E9ogL7HPPgvcHS4zMiXBF5kyOrNcxHFHYJ7IyMw,3220
 crypticorn/common/mixins.py,sha256=LKPcNTR8uREeDGWTlWozNx7rS1mYdQVx1RllLhxIAsE,1640
 crypticorn/common/pagination.py,sha256=c07jrMNrBaNTmgx4sppdP7ND4RNT7NBqBXWvofazIlE,2251
-crypticorn/common/scopes.py,sha256=gbxrzME18ASQS18IHg96TvFZxh5-O8ffD2caGpfs0lc,2333
-crypticorn/common/status_router.py,sha256=s7LY3aNQPhtDUgNWHRszfCQMl0Uh13li_jR8jeeolnw,1139
+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=aaAqWAnaZ2CkHU9cJgeZKyUoc6JnC6oEQhUa_P0bWKw,3380
+crypticorn/common/router/status_router.py,sha256=RIgyNVVnD6Y5Qsfz_oJk0BDuPPmCBM_B4ytcRiSXvo8,576
 crypticorn/hive/__init__.py,sha256=hRfTlEzEql4msytdUC_04vfaHzVKG5CGZle1M-9QFgY,81
 crypticorn/hive/main.py,sha256=4oQ2RybZMbe0kRxVJrVAABsN5kUTCMExQFJDSnAzBUY,2428
 crypticorn/hive/utils.py,sha256=dxQ_OszrnTsslO5hDefMmgfj6yRwRPr8sr17fGizWIw,2066
@@ -224,8 +227,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.7.5.dist-info/METADATA,sha256=5E_LCIIfd_O0t6Q8HBqaVLQVSvq_xgvVmMiCgPW_AZU,6607
-crypticorn-2.7.5.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-crypticorn-2.7.5.dist-info/entry_points.txt,sha256=d_xHsGvUTebPveVUK0SrpDFQ5ZRSjlI7lNCc11sn2PM,59
-crypticorn-2.7.5.dist-info/top_level.txt,sha256=EP3NY216qIBYfmvGl0L2Zc9ItP0DjGSkiYqd9xJwGcM,11
-crypticorn-2.7.5.dist-info/RECORD,,
+crypticorn-2.8.0rc1.dist-info/METADATA,sha256=HdPQkiN3MMSTb4TS9IJQrhfN758XihFO2IG1OBJtrMg,6610
+crypticorn-2.8.0rc1.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
+crypticorn-2.8.0rc1.dist-info/entry_points.txt,sha256=d_xHsGvUTebPveVUK0SrpDFQ5ZRSjlI7lNCc11sn2PM,59
+crypticorn-2.8.0rc1.dist-info/top_level.txt,sha256=EP3NY216qIBYfmvGl0L2Zc9ItP0DjGSkiYqd9xJwGcM,11
+crypticorn-2.8.0rc1.dist-info/RECORD,,