crypticorn 2.8.0rc1__tar.gz → 2.8.0rc2__tar.gz

{crypticorn-2.8.0rc1 → crypticorn-2.8.0rc2}/CHANGELOG.md

@@ -1,6 +1,25 @@
 # CHANGELOG
 
 
+## v2.8.0-rc.2 (2025-05-05)
+
+### Bug Fixes
+
+- Add psutil as dependency
+  ([`23cf77e`](https://github.com/crypticorn-ai/api-client/commit/23cf77ea002a2d6f8e31cd858a2dcc1890b8d8c1))
+
+- Centralize cors middleware
+  ([`e5aa2d6`](https://github.com/crypticorn-ai/api-client/commit/e5aa2d60254076848530a6d5b9a349058ee45ac7))
+
+- Run logging configuration in init of the library
+  ([`8b725e1`](https://github.com/crypticorn-ai/api-client/commit/8b725e18154d184c8593b8de086b0a789b6e180c))
+
+### Features
+
+- Provide lifespan event for fastapi apps to configure logging on startup
+  ([`9a2e1c4`](https://github.com/crypticorn-ai/api-client/commit/9a2e1c45d87ad1581c0e1646689eba6ca0876564))
+
+
 ## v2.8.0-rc.1 (2025-05-04)
 
 ### Features

{crypticorn-2.8.0rc1/crypticorn.egg-info → crypticorn-2.8.0rc2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.8.0rc1
+Version: 2.8.0rc2
 Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
 License: MIT
@@ -16,6 +16,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: fastapi<1.0.0,>=0.115.0
 Requires-Dist: click<9.0.0,>=8.0.0
+Requires-Dist: psutil<8.0.0,>=7.0.0
 Requires-Dist: urllib3<3.0.0,>=1.25.3
 Requires-Dist: python_dateutil<3.0.0,>=2.8.2
 Requires-Dist: aiohttp<4.0.0,>=3.8.4

{crypticorn-2.8.0rc1 → crypticorn-2.8.0rc2}/crypticorn/__init__.py

@@ -3,6 +3,10 @@
 .. include:: ../CHANGELOG.md
 """
 
+from crypticorn.common.logging import configure_logging
+configure_logging("crypticorn")
+
 from crypticorn.client import ApiClient
 
 __all__ = ["ApiClient"]
+

{crypticorn-2.8.0rc1 → crypticorn-2.8.0rc2}/crypticorn/auth/client/models/create_api_key_request.py

@@ -78,10 +78,12 @@ class CreateApiKeyRequest(BaseModel):
                     "read:metrics:tokens",
                     "read:metrics:markets",
                     "read:sentiment",
+                    "read:admin",
+                    "write:admin",
                 ]
             ):
                 raise ValueError(
-                    "each list item must be one of ('read:predictions', 'read:hive:model', 'read:hive:data', 'write:hive:model', 'read:trade:bots', 'write:trade:bots', 'read:trade:exchangekeys', 'write:trade:exchangekeys', 'read:trade:orders', 'read:trade:actions', 'write:trade:actions', 'read:trade:exchanges', 'read:trade:futures', 'write:trade:futures', 'read:trade:notifications', 'write:trade:notifications', 'read:trade:strategies', 'write:trade:strategies', 'read:pay:payments', 'read:pay:products', 'write:pay:products', 'read:pay:now', 'write:pay:now', 'read:metrics:marketcap', 'read:metrics:indicators', 'read:metrics:exchanges', 'read:metrics:tokens', 'read:metrics:markets', 'read:sentiment')"
+                    "each list item must be one of ('read:predictions', 'read:hive:model', 'read:hive:data', 'write:hive:model', 'read:trade:bots', 'write:trade:bots', 'read:trade:exchangekeys', 'write:trade:exchangekeys', 'read:trade:orders', 'read:trade:actions', 'write:trade:actions', 'read:trade:exchanges', 'read:trade:futures', 'write:trade:futures', 'read:trade:notifications', 'write:trade:notifications', 'read:trade:strategies', 'write:trade:strategies', 'read:pay:payments', 'read:pay:products', 'write:pay:products', 'read:pay:now', 'write:pay:now', 'read:metrics:marketcap', 'read:metrics:indicators', 'read:metrics:exchanges', 'read:metrics:tokens', 'read:metrics:markets', 'read:sentiment', 'read:admin', 'write:admin')"
                 )
         return value
 

{crypticorn-2.8.0rc1 → crypticorn-2.8.0rc2}/crypticorn/auth/client/models/get_api_keys200_response_inner.py

@@ -86,10 +86,12 @@ class GetApiKeys200ResponseInner(BaseModel):
                     "read:metrics:tokens",
                     "read:metrics:markets",
                     "read:sentiment",
+                    "read:admin",
+                    "write:admin",
                 ]
             ):
                 raise ValueError(
-                    "each list item must be one of ('read:predictions', 'read:hive:model', 'read:hive:data', 'write:hive:model', 'read:trade:bots', 'write:trade:bots', 'read:trade:exchangekeys', 'write:trade:exchangekeys', 'read:trade:orders', 'read:trade:actions', 'write:trade:actions', 'read:trade:exchanges', 'read:trade:futures', 'write:trade:futures', 'read:trade:notifications', 'write:trade:notifications', 'read:trade:strategies', 'write:trade:strategies', 'read:pay:payments', 'read:pay:products', 'write:pay:products', 'read:pay:now', 'write:pay:now', 'read:metrics:marketcap', 'read:metrics:indicators', 'read:metrics:exchanges', 'read:metrics:tokens', 'read:metrics:markets', 'read:sentiment')"
+                    "each list item must be one of ('read:predictions', 'read:hive:model', 'read:hive:data', 'write:hive:model', 'read:trade:bots', 'write:trade:bots', 'read:trade:exchangekeys', 'write:trade:exchangekeys', 'read:trade:orders', 'read:trade:actions', 'write:trade:actions', 'read:trade:exchanges', 'read:trade:futures', 'write:trade:futures', 'read:trade:notifications', 'write:trade:notifications', 'read:trade:strategies', 'write:trade:strategies', 'read:pay:payments', 'read:pay:products', 'write:pay:products', 'read:pay:now', 'write:pay:now', 'read:metrics:marketcap', 'read:metrics:indicators', 'read:metrics:exchanges', 'read:metrics:tokens', 'read:metrics:markets', 'read:sentiment', 'read:admin', 'write:admin')"
                 )
         return value
 

{crypticorn-2.8.0rc1 → crypticorn-2.8.0rc2}/crypticorn/common/__init__.py

@@ -10,5 +10,6 @@ from crypticorn.common.exceptions import *
 from crypticorn.common.pagination import *
 from crypticorn.common.logging import *
 from crypticorn.common.ansi_colors import *
+from crypticorn.common.middleware import *
 from crypticorn.common.router.status_router import router as status_router
 from crypticorn.common.router.admin_router import router as admin_router

{crypticorn-2.8.0rc1 → crypticorn-2.8.0rc2}/crypticorn/common/ansi_colors.py

@@ -1,10 +1,6 @@
 from enum import StrEnum
 from typing import TYPE_CHECKING
 
-if TYPE_CHECKING:
-    pass
-
-
 class AnsiColors(StrEnum):
     # Regular Text Colors
     BLACK = "\033[30m"  # black

{crypticorn-2.8.0rc1 → crypticorn-2.8.0rc2}/crypticorn/common/auth.py

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

{crypticorn-2.8.0rc1 → crypticorn-2.8.0rc2}/crypticorn/common/exceptions.py

@@ -95,28 +95,35 @@ class WebSocketException(HTTPException):
 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)
-    res =  JSONResponse(
-        status_code=body.enrich().status_code, content=HTTPException(content=body).detail
+    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) -> JSONResponse:
+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)
     res = JSONResponse(
-        status_code=body.enrich().status_code, content=HTTPException(content=body).detail
+        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) -> JSONResponse:
+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)
     res = JSONResponse(
-        status_code=body.enrich().status_code, content=HTTPException(content=body).detail
+        status_code=body.enrich().status_code,
+        content=HTTPException(content=body).detail,
     )
     logger.error(f"Response validation error: {res}")
     return res

{crypticorn-2.8.0rc1 → crypticorn-2.8.0rc2}/crypticorn/common/logging.py

@@ -1,8 +1,9 @@
+from __future__ import annotations
 # shared_logger.py
 import logging
-from logging import _nameToLevel, _levelToName
 import sys
 from contextvars import ContextVar
+from contextlib import asynccontextmanager
 import json
 from pydantic import BaseModel
 from enum import StrEnum
@@ -10,6 +11,7 @@ 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"
@@ -34,11 +36,11 @@ class LogLevel(ValidateEnumMixin, StrEnum):
 
     @staticmethod
     def get_level(level: "LogLevel") -> int:
-        return _nameToLevel.get(level, logging.INFO)
+        return logging._nameToLevel.get(level, logging.INFO)
 
     @staticmethod
     def get_name(level: int) -> "LogLevel":
-        return LogLevel(_levelToName.get(level, "INFO"))
+        return LogLevel(logging._levelToName.get(level, "INFO"))
 
 
 _LOGFORMAT = (
@@ -47,9 +49,7 @@ _LOGFORMAT = (
     f"%(levelcolor)s%(levelname)s{C.RESET} - "
     f"%(message)s"
 )
-_PLAIN_LOGFORMAT = (
-    "%(asctime)s - " "%(name)s - " "%(levelname)s - " "%(message)s"
-)
+_PLAIN_LOGFORMAT = "%(asctime)s - " "%(name)s - " "%(levelname)s - " "%(message)s"
 _DATEFMT = "%Y-%m-%d %H:%M:%S.%f:"
 
 
@@ -67,20 +67,26 @@ class CustomFormatter(logging.Formatter):
         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,
+
+def configure_logging(
+    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."""
+) -> None:
+    """Configures the logging for the application.
+    Run this function as early as possible in the application (for example using the `lifespan` parameter in FastAPI).
+    Then use can use the default `logging.getLogger(__name__)` method to get the logger.
+    """
     logger = logging.getLogger(name)
 
-    if logger.handlers: # clear existing handlers to avoid duplicates
+    if logger.handlers:  # clear existing handlers to avoid duplicates
         logger.handlers.clear()
 
-    logger.setLevel(min(stdout_level, file_level)) # set to most verbose level
+    logger.setLevel(min(stdout_level, file_level))  # set to most verbose level
 
     # Configure stdout handler
     stdout_handler = logging.StreamHandler(sys.stdout)
@@ -93,11 +99,18 @@ def get_logger(
     # 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 = 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
+
+def disable_logging():
+    """Disable logging for the crypticorn logger.
+    """
+    logger = logging.getLogger("crypticorn")
+    logger.disabled = True

crypticorn-2.8.0rc2/crypticorn/common/middleware.py

@@ -0,0 +1,27 @@
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+from crypticorn.common.logging import configure_logging
+import logging
+
+
+def add_cors_middleware(app: "FastAPI"):
+    app.add_middleware(
+        CORSMiddleware,
+        allow_origins=[
+            "http://localhost:5173", # vite dev server
+            "http://localhost:4173", # vite preview server
+        ],
+        allow_origin_regex="^https:\/\/([a-zA-Z0-9-]+\.)*crypticorn\.(dev|com)\/?$", # matches (multiple or no) subdomains of crypticorn.dev and crypticorn.com
+        allow_credentials=True,
+        allow_methods=["*"],
+        allow_headers=["*"],
+    )
+
+async def default_lifespan(app: FastAPI):
+    """Default lifespan for the applications.
+    This is used to configure the logging for the application.
+    To override this, pass a different lifespan to the FastAPI constructor or call this lifespan within a custom lifespan.
+    """
+    configure_logging(__name__) # for the consuming app
+    logger = logging.getLogger(__name__)
+    yield

{crypticorn-2.8.0rc1 → crypticorn-2.8.0rc2}/crypticorn/common/router/admin_router.py

@@ -6,15 +6,12 @@ ONLY ALLOW ACCESS TO THIS ROUTER WITH ADMIN SCOPES.
 """
 
 import os
-import sys
 import pkg_resources
 import threading
 import time
-import json
 import psutil
-from fastapi import APIRouter, HTTPException, Body, Query
+from fastapi import APIRouter, Query
 from typing import Literal, Union
-from dotenv import dotenv_values
 from crypticorn.common.logging import LogLevel
 import logging
 
@@ -22,6 +19,7 @@ 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:
     """
@@ -29,10 +27,9 @@ async def get_logging_level() -> LogLevel:
     """
     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]:
+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":
@@ -73,7 +70,9 @@ def get_container_limits() -> dict:
         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:
+        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"
@@ -86,11 +85,16 @@ def get_container_limits() -> dict:
 @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."
+        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],
+        [
+            {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-2.8.0rc1 → crypticorn-2.8.0rc2}/crypticorn/common/router/status_router.py

@@ -16,9 +16,9 @@ async def ping() -> str:
 @router.get("/time", operation_id="getTime")
 async def time(type: Literal["iso", "unix"] = "iso") -> str:
     """
-    Returns the current time in the specified format.
+    Returns the current time in either ISO or Unix timestamp (seconds) format.
     """
     if type == "iso":
         return datetime.now().isoformat()
-    else:
+    elif type == "unix":
         return str(int(datetime.now().timestamp()))

{crypticorn-2.8.0rc1 → crypticorn-2.8.0rc2/crypticorn.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.8.0rc1
+Version: 2.8.0rc2
 Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
 License: MIT
@@ -16,6 +16,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: fastapi<1.0.0,>=0.115.0
 Requires-Dist: click<9.0.0,>=8.0.0
+Requires-Dist: psutil<8.0.0,>=7.0.0
 Requires-Dist: urllib3<3.0.0,>=1.25.3
 Requires-Dist: python_dateutil<3.0.0,>=2.8.2
 Requires-Dist: aiohttp<4.0.0,>=3.8.4

{crypticorn-2.8.0rc1 → crypticorn-2.8.0rc2}/crypticorn.egg-info/SOURCES.txt

@@ -81,6 +81,7 @@ crypticorn/common/enums.py
 crypticorn/common/errors.py
 crypticorn/common/exceptions.py
 crypticorn/common/logging.py
+crypticorn/common/middleware.py
 crypticorn/common/mixins.py
 crypticorn/common/pagination.py
 crypticorn/common/scopes.py

{crypticorn-2.8.0rc1 → crypticorn-2.8.0rc2}/crypticorn.egg-info/requires.txt

@@ -1,5 +1,6 @@
 fastapi<1.0.0,>=0.115.0
 click<9.0.0,>=8.0.0
+psutil<8.0.0,>=7.0.0
 urllib3<3.0.0,>=1.25.3
 python_dateutil<3.0.0,>=2.8.2
 aiohttp<4.0.0,>=3.8.4

{crypticorn-2.8.0rc1 → crypticorn-2.8.0rc2}/pyproject.toml

@@ -5,7 +5,7 @@ readme = "README.md"
 license = {text = "MIT"}
 requires-python = ">=3.10"
 authors = [{name = "Crypticorn", email = "timon@crypticorn.com"}]
-version = "2.8.0-rc.1"
+version = "2.8.0-rc.2"
 keywords = ["machine learning", "data science", "crypto", "modelling"]
 dynamic = ["dependencies", "optional-dependencies"]
 

{crypticorn-2.8.0rc1 → crypticorn-2.8.0rc2}/requirements/main.txt

@@ -1,6 +1,7 @@
 # crypticorn/common
 fastapi>=0.115.0, < 1.0.0
 click >= 8.0.0, < 9.0.0
+psutil >= 7.0.0, < 8.0.0
 
 # crypticorn/trade/requirements.txt
 urllib3 >= 1.25.3, < 3.0.0