crypticorn 2.9.0rc1__tar.gz → 2.10.1__tar.gz

{crypticorn-2.9.0rc1 → crypticorn-2.10.1}/CHANGELOG.md

@@ -1,28 +1,94 @@
 # CHANGELOG
 
 
+## v2.10.1 (2025-05-12)
+
+### Bug Fixes
+
+- Fixes optional symbol in get_marketcap_symbols function
+  ([`3522a09`](https://github.com/crypticorn-ai/api-client/commit/3522a097cb159d638c717b26f9d607e813d210a9))
+
+### Build System
+
+- Include static files in the structure in the distribution
+  ([`eb87ab4`](https://github.com/crypticorn-ai/api-client/commit/eb87ab44edb7558b09835ffe092d4a4d9517b79d))
+
+### Refactoring
+
+- Remove usage of deprecated `ExcludeEnumMixin`
+  ([`bf4f4fb`](https://github.com/crypticorn-ai/api-client/commit/bf4f4fb4dc092a9909a6e536c5e5455244e13aac))
+
+
+## v2.10.0 (2025-05-09)
+
+### Build System
+
+- Include info .md files and license in distribution
+  ([`3c3d065`](https://github.com/crypticorn-ai/api-client/commit/3c3d0655b67478f98d970e7ad218e8947b8a9ec0))
+
+### Continuous Integration
+
+- Fix typo in testing workflow
+  ([`e0fd734`](https://github.com/crypticorn-ai/api-client/commit/e0fd73450efda0c41ed583a771e0b6774e6a8dbd))
+
+- Properly read env vars
+  ([`6d25286`](https://github.com/crypticorn-ai/api-client/commit/6d252865986b974789831e91cedd45e9a594ebbc))
+
+- Update test workflow
+  ([`97b7b8b`](https://github.com/crypticorn-ai/api-client/commit/97b7b8b76691e91d788030e603e2fc65ac7ba8c8))
+
+### Features
+
+- Add new init template to the CLI for generating a env merging script
+  ([`7e3a71a`](https://github.com/crypticorn-ai/api-client/commit/7e3a71a0f67eceb1ab1f8545eeba0a390736e129))
+
+- Add version command in the CLI (crypticorn version)
+  ([`289eef4`](https://github.com/crypticorn-ai/api-client/commit/289eef48fa51f771c9b461206a93470f35ce2369))
+
+
+## v2.9.0 (2025-05-08)
+
+### Build System
+
+- Add python-semantic-release as an dev dependency
+  ([`72dfc09`](https://github.com/crypticorn-ai/api-client/commit/72dfc092b7b4fde231e6c62d3bcca33ec270bf30))
+
+### Features
+
+- Use regex pattern in /dependencies endpoint
+  ([`7a7792f`](https://github.com/crypticorn-ai/api-client/commit/7a7792f33460b5fe4404d6f46ab680cca204a8f5))
+
+
 ## v2.9.0-rc.1 (2025-05-08)
 
 ### Bug Fixes
 
 - Capture and format warnings in logging output
-  ([`6eabac6`](https://github.com/crypticorn-ai/api-client/commit/6eabac6fc6f9565b214ba354947c25c8b37bac36))
+  ([`5a1d317`](https://github.com/crypticorn-ai/api-client/commit/5a1d31721507dae015e9d9568579e91b12906ee4))
 
 - Use `contextlib.asynccontextmanager` for starlette lifespan
-  ([`1778b85`](https://github.com/crypticorn-ai/api-client/commit/1778b85da213fa5e6b8b26b462aad73ea9f0a330))
+  ([`c253dd1`](https://github.com/crypticorn-ai/api-client/commit/c253dd133dff5073f355ed8f93c0be1814b739f2))
 
 ### Documentation
 
 - Update docstrings and module descriptions
-  ([`34a1b44`](https://github.com/crypticorn-ai/api-client/commit/34a1b44db18a987c5a741a9b829b7a79597558bc))
+  ([`c80f306`](https://github.com/crypticorn-ai/api-client/commit/c80f30614641f09366ca3566295e9bce8eee828d))
 
 ### Features
 
 - Add deprecation warnings in call and in-code support
-  ([`0f5acee`](https://github.com/crypticorn-ai/api-client/commit/0f5aceeb53b34f1d7676d9bb0d3667d69f1b43b2))
+  ([`b3100e6`](https://github.com/crypticorn-ai/api-client/commit/b3100e69874b8fca439778351c2834b5ae2b91b6))
 
 - Provide default openapi tags from the status and admin router
-  ([`dc23701`](https://github.com/crypticorn-ai/api-client/commit/dc23701f0b3493dab677608d8ce80c59fcf15269))
+  ([`e8ef966`](https://github.com/crypticorn-ai/api-client/commit/e8ef966bc9ee60a17ef8842a041d5e1800c32d93))
+
+
+## v2.8.2 (2025-05-08)
+
+### Bug Fixes
+
+- Hotfix response type error
+  ([`7cc14fc`](https://github.com/crypticorn-ai/api-client/commit/7cc14fcced66441d9e320ad754a164ca016cda26))
 
 
 ## v2.8.1 (2025-05-07)

crypticorn-2.10.1/LICENSE

@@ -0,0 +1,15 @@
+Copyright © 2025 Crypticorn
+
+All rights reserved. This software and accompanying documentation files (collectively referred to as "the Software") are the proprietary property of Crypticorn. Any unauthorised reproduction, modification, integration, publication, distribution, sublicensing, sale, or enabling access to the Software without explicit written permission from Crypticorn is strictly prohibited, subject to the conditions outlined herein:
+
+1. The aforementioned copyright notice and this permission notice must be included unaltered in all copies, or significant portions, of the Software.
+
+2. The Software is provided "AS IS", without any warranty, whether express or implied. Crypticorn expressly disclaims any guarantees, including but not limited to those of satisfactory quality, fitness for a particular purpose, or non-infringement of third-party rights.
+
+3. In no event shall Crypticorn, its authors, or copyright holders be held liable for any claim, damages, or other liability arising from or associated with the use of the Software or any other dealings involving the Software, to the extent that such liability can be limited or excluded by applicable law.
+
+Changes to this agreement may be made without notice, and it is the user's responsibility to keep abreast of any changes. This agreement and its interpretation are subject to the laws of the Federal Republic of Germany.
+
+If any provision of this license agreement is held to be invalid or unenforceable under applicable law, the remaining provisions will continue in full force and effect. Crypticorn's failure to enforce any provision of this agreement does not constitute a waiver of its right to do so in the future.
+
+This agreement is written in English. In the event of any discrepancy between the English version and any translation, the English version shall prevail.

crypticorn-2.10.1/MANIFEST.in

@@ -0,0 +1,5 @@
+graft crypticorn/cli/templates
+include CHANGELOG.md
+include README.md
+include LICENSE
+include static

{crypticorn-2.9.0rc1/crypticorn.egg-info → crypticorn-2.10.1}/PKG-INFO

@@ -1,9 +1,23 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.9.0rc1
+Version: 2.10.1
 Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
-License: MIT
+License: Copyright © 2025 Crypticorn
+        
+        All rights reserved. This software and accompanying documentation files (collectively referred to as "the Software") are the proprietary property of Crypticorn. Any unauthorised reproduction, modification, integration, publication, distribution, sublicensing, sale, or enabling access to the Software without explicit written permission from Crypticorn is strictly prohibited, subject to the conditions outlined herein:
+        
+        1. The aforementioned copyright notice and this permission notice must be included unaltered in all copies, or significant portions, of the Software.
+        
+        2. The Software is provided "AS IS", without any warranty, whether express or implied. Crypticorn expressly disclaims any guarantees, including but not limited to those of satisfactory quality, fitness for a particular purpose, or non-infringement of third-party rights.
+        
+        3. In no event shall Crypticorn, its authors, or copyright holders be held liable for any claim, damages, or other liability arising from or associated with the use of the Software or any other dealings involving the Software, to the extent that such liability can be limited or excluded by applicable law.
+        
+        Changes to this agreement may be made without notice, and it is the user's responsibility to keep abreast of any changes. This agreement and its interpretation are subject to the laws of the Federal Republic of Germany.
+        
+        If any provision of this license agreement is held to be invalid or unenforceable under applicable law, the remaining provisions will continue in full force and effect. Crypticorn's failure to enforce any provision of this agreement does not constitute a waiver of its right to do so in the future.
+        
+        This agreement is written in English. In the event of any discrepancy between the English version and any translation, the English version shall prevail.
 Project-URL: Homepage, https://crypticorn.com
 Project-URL: Documentation, https://docs.crypticorn.com
 Project-URL: Dashboard, https://app.crypticorn.com
@@ -20,6 +34,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
+License-File: LICENSE
 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
@@ -35,14 +50,13 @@ Requires-Dist: tqdm<5.0.0,>=4.67.0
 Provides-Extra: dev
 Requires-Dist: build; extra == "dev"
 Requires-Dist: twine; extra == "dev"
-Requires-Dist: streamlit; extra == "dev"
-Requires-Dist: httpx; extra == "dev"
 Requires-Dist: black; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: isort; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: openapi-generator-cli<8.0.0,>=7.12.0; extra == "dev"
 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"
@@ -51,6 +65,7 @@ Requires-Dist: python-dotenv==1.0.1; extra == "test"
 Requires-Dist: PyJWT==2.10.0; extra == "test"
 Provides-Extra: extra
 Requires-Dist: pandas<3.0.0,>=2.2.0; extra == "extra"
+Dynamic: license-file
 
 ## What is Crypticorn?
 
@@ -83,7 +98,7 @@ from crypticorn import ApiClient
 ```
 The ApiClient serves as the central interface for API operations. It instantiates multiple API wrappers corresponding to our micro services. These are structured the following:
 
-<img src="../static/pip-structure.svg" alt="pip package structure" />
+<img src="pip-structure.svg" alt="pip package structure" />
 
 You can either explore each API by clicking through the library or checkout the [API Documentation](https://docs.crypticorn.com/api).
 

{crypticorn-2.9.0rc1 → crypticorn-2.10.1}/README.md

@@ -29,7 +29,7 @@ from crypticorn import ApiClient
 ```
 The ApiClient serves as the central interface for API operations. It instantiates multiple API wrappers corresponding to our micro services. These are structured the following:
 
-<img src="../static/pip-structure.svg" alt="pip package structure" />
+<img src="pip-structure.svg" alt="pip package structure" />
 
 You can either explore each API by clicking through the library or checkout the [API Documentation](https://docs.crypticorn.com/api).
 

crypticorn-2.10.1/crypticorn/cli/__init__.py

@@ -0,0 +1,4 @@
+from crypticorn.cli.init import init_group
+from crypticorn.cli.version import version
+
+__all__ = ["init_group", "version"]

{crypticorn-2.9.0rc1 → crypticorn-2.10.1}/crypticorn/cli/__main__.py

@@ -1,7 +1,7 @@
 # crypticorn/cli.py
 
 import click
-from crypticorn.cli import init_group
+from crypticorn.cli import init_group, version
 
 
 @click.group()
@@ -11,6 +11,7 @@ def cli():
 
 
 cli.add_command(init_group, name="init")
+cli.add_command(version, name="version")
 
 if __name__ == "__main__":
     cli()

{crypticorn-2.9.0rc1 → crypticorn-2.10.1}/crypticorn/cli/init.py

@@ -31,6 +31,13 @@ def copy_template(template_name: str, target_path: Path):
     click.secho(f"✅ Created: {target_path}", fg="green")
 
 
+def check_file_exists(path: Path, force: bool):
+    if path.exists() and not force:
+        click.secho(f"File already exists, use --force / -f to overwrite", fg="red")
+        return False
+    return True
+
+
 @click.group()
 def init_group():
     """Initialize files like CI configs, linters, etc."""
@@ -61,8 +68,7 @@ def init_docker(output, force):
         click.secho("Output path is a file, please provide a directory path", fg="red")
         return
     target = (Path(output) if output else root) / "Dockerfile"
-    if target.exists() and not force:
-        click.secho("File already exists, use --force / -f to overwrite", fg="red")
+    if not check_file_exists(target, force):
         return
     copy_template("Dockerfile", target)
     click.secho("Make sure to update the Dockerfile", fg="yellow")
@@ -80,13 +86,12 @@ def init_auth(output, force):
         click.secho("Output path is a file, please provide a directory path", fg="red")
         return
     target = (Path(output) if output else root) / "auth.py"
-    if target.exists() and not force:
-        click.secho("File already exists, use --force / -f to overwrite", fg="red")
+    if not check_file_exists(target, force):
         return
     copy_template("auth.py", target)
     click.secho(
         """
-    Make sure to update the .env file with:
+    Make sure to update the .env and .env.example files with:
         IS_DOCKER=0
         API_ENV=local
     and the docker-compose.yml file with:
@@ -106,7 +111,17 @@ def init_dependabot(force):
     """Add dependabot.yml"""
     root = get_git_root()
     target = root / ".github/dependabot.yml"
-    if target.exists() and not force:
-        click.secho("File already exists, use --force / -f to overwrite", fg="red")
+    if not check_file_exists(target, force):
         return
     copy_template("dependabot.yml", target)
+
+
+@init_group.command("merge-env")
+@click.option("-f", "--force", is_flag=True, help="Force overwrite the .env file")
+def init_merge_env(force):
+    """Add script to merge environment and file variables into .env"""
+    root = get_git_root()
+    target = root / "scripts/merge-env.sh"
+    if not check_file_exists(target, force):
+        return
+    copy_template("merge-env.sh", target)

crypticorn-2.10.1/crypticorn/cli/templates/merge-env.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+# this script merges the env variables from the environment and the .env.example file into the .env file
+# the appended variables take precedence over the .env.example variables (if both are set)
+
+# Make executable before running in github actions
+# chmod +x scripts/merge-env.sh
+
+# Usage in a github action:
+# - name: Generate .env
+#   run: ./scripts/merge-env.sh
+
+set -e
+
+cp .env.example .env
+echo >> .env
+printenv | awk -F= '{print $1"=\""substr($0, index($0,$2))"\""}' >> .env

crypticorn-2.10.1/crypticorn/cli/version.py

@@ -0,0 +1,8 @@
+import importlib.metadata
+import click
+
+
+@click.command("version")
+def version():
+    """Print the version of the crypticorn package"""
+    click.echo(importlib.metadata.distribution("crypticorn").version)

{crypticorn-2.9.0rc1 → crypticorn-2.10.1}/crypticorn/common/enums.py

@@ -1,17 +1,17 @@
 """Defines common enumerations used throughout the codebase for type safety and consistency."""
 
 from enum import StrEnum
-from crypticorn.common.mixins import ValidateEnumMixin, ExcludeEnumMixin
+from crypticorn.common.mixins import ValidateEnumMixin
 
 
-class Exchange(ValidateEnumMixin, ExcludeEnumMixin, StrEnum):
+class Exchange(ValidateEnumMixin, StrEnum):
     """Supported exchanges for trading"""
 
     KUCOIN = "kucoin"
     BINGX = "bingx"
 
 
-class InternalExchange(ValidateEnumMixin, ExcludeEnumMixin, StrEnum):
+class InternalExchange(ValidateEnumMixin, StrEnum):
     """All exchanges we are using, including public (Exchange)"""
 
     KUCOIN = "kucoin"
@@ -22,7 +22,7 @@ class InternalExchange(ValidateEnumMixin, ExcludeEnumMixin, StrEnum):
     BITGET = "bitget"
 
 
-class MarketType(ValidateEnumMixin, ExcludeEnumMixin, StrEnum):
+class MarketType(ValidateEnumMixin, StrEnum):
     """
     Market types
     """

{crypticorn-2.9.0rc1 → crypticorn-2.10.1}/crypticorn/common/errors.py

@@ -2,10 +2,10 @@
 
 from enum import Enum, StrEnum
 from fastapi import status
-from crypticorn.common.mixins import ExcludeEnumMixin, ApiErrorFallback
+from crypticorn.common.mixins import ApiErrorFallback
 
 
-class ApiErrorType(ExcludeEnumMixin, StrEnum):
+class ApiErrorType(StrEnum):
     """Type of the API error."""
 
     USER_ERROR = "user error"
@@ -18,7 +18,7 @@ class ApiErrorType(ExcludeEnumMixin, StrEnum):
     """error that does not need to be handled or does not affect the program or is a placeholder."""
 
 
-class ApiErrorIdentifier(ExcludeEnumMixin, StrEnum):
+class ApiErrorIdentifier(StrEnum):
     """Unique identifier of the API error."""
 
     ALLOCATION_BELOW_EXPOSURE = "allocation_below_current_exposure"
@@ -98,13 +98,12 @@ class ApiErrorIdentifier(ExcludeEnumMixin, StrEnum):
     UNKNOWN_ERROR = "unknown_error_occurred"
     URL_NOT_FOUND = "requested_resource_not_found"
 
-    @property
     def get_error(self) -> "ApiError":
         """Get the corresponding ApiError."""
-        return ApiError[self.value]
+        return getattr(ApiError, self.name)
 
 
-class ApiErrorLevel(ExcludeEnumMixin, StrEnum):
+class ApiErrorLevel(StrEnum):
     """Level of the API error."""
 
     ERROR = "error"
@@ -113,7 +112,7 @@ class ApiErrorLevel(ExcludeEnumMixin, StrEnum):
     WARNING = "warning"
 
 
-class ApiError(ExcludeEnumMixin, Enum, metaclass=ApiErrorFallback):
+class ApiError(Enum, metaclass=ApiErrorFallback):
     # Fallback to UNKNOWN_ERROR for error codes not yet published to PyPI.
     """Crypticorn API error enumeration."""
 

{crypticorn-2.9.0rc1 → crypticorn-2.10.1}/crypticorn/common/mixins.py

@@ -39,10 +39,13 @@ class ValidateEnumMixin:
 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,
-    )
+    def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
+        if cls.__name__.startswith("ExcludeEnumMixin"):
+            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):
@@ -56,7 +59,7 @@ class ApiErrorFallback(EnumMeta):
 
     def __getattr__(cls, name):
         # Let Pydantic/internal stuff pass silently ! fragile
-        if name.startswith("__"):
+        if name.startswith("__") or name.startswith("_pytest"):
             raise AttributeError(name)
         _logger.warning(
             f"Unknown enum member '{name}' - update crypticorn package or check for typos"

crypticorn-2.10.1/crypticorn/common/openapi.py

@@ -0,0 +1,10 @@
+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-2.9.0rc1 → crypticorn-2.10.1}/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,20 @@ 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-2.9.0rc1 → crypticorn-2.10.1}/crypticorn/common/router/status_router.py

@@ -13,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-2.9.0rc1 → crypticorn-2.10.1}/crypticorn/hive/client/__init__.py

@@ -49,8 +49,8 @@ from crypticorn.hive.client.models.evaluation_response import EvaluationResponse
 from crypticorn.hive.client.models.exception_detail import ExceptionDetail
 from crypticorn.hive.client.models.feature_size import FeatureSize
 from crypticorn.hive.client.models.log_level import LogLevel
-from crypticorn.hive.client.models.model import Model
 from crypticorn.hive.client.models.model_create import ModelCreate
+from crypticorn.hive.client.models.model_read import ModelRead
 from crypticorn.hive.client.models.model_status import ModelStatus
 from crypticorn.hive.client.models.model_update import ModelUpdate
 from crypticorn.hive.client.models.target import Target