crypticorn 2.7.3__py3-none-any.whl → 2.7.5__py3-none-any.whl

crypticorn/cli/templates/Dockerfile

@@ -0,0 +1,33 @@
+FROM python:3.11.5
+
+# This line is used to allow the cache to be busted (only busts in CI)
+ARG CACHEBUST=1
+COPY ./requirements.txt /code/requirements.txt
+
+WORKDIR /code
+# set API_ENV in .env
+# API_ENV=local
+# add to compose file
+# build:
+#     context: .
+#     dockerfile: src/api/Dockerfile
+#     args:
+#       - API_ENV=${API_ENV}
+# environment:
+#     - API_ENV=${API_ENV}
+#
+# and to the workflow:
+# env:
+#     API_ENV: ${{ github.ref == 'refs/heads/main' && 'prod' || 'dev' }}
+ARG API_ENV
+
+RUN pip install --no-cache-dir -r requirements.txt
+
+RUN if [ "$API_ENV" != "prod" ]; then \
+    pip install --pre crypticorn; \
+    fi
+
+
+COPY ./src /code/src
+
+CMD ["uvicorn", "src.api.main:app", "--host", "0.0.0.0", "--port", "3000"]

crypticorn/cli/templates/dependabot.yml

@@ -0,0 +1,26 @@
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"  # root folder, or change if your requirements.txt is elsewhere
+    schedule:
+      interval: "weekly"  # options: "daily", "weekly", "monthly"
+    open-pull-requests-limit: 3
+    labels:
+      - "dependencies"
+    rebase-strategy: "auto"  # will rebase PRs if needed
+    ignore:
+      - dependency-name: "*"
+        update-types: ["version-update:semver-major"]  # avoids risky major bumps
+    commit-message:
+      prefix: "deps"
+    target-branch: "dev" # ! merge to main after pr is merged
+    groups:
+      pip-dependencies:
+        patterns:
+          - "*"
+        update-types:
+          - "minor"
+          - "patch"

crypticorn/cli/templates/ruff.yml

@@ -0,0 +1,12 @@
+# https://docs.astral.sh/ruff/integrations/#github-actions
+name: Ruff
+on: [ push, pull_request ]
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3
+        with:
+          args: check --ignore E402 --output-format=github .
+          src: "./src"

crypticorn/common/errors.py

@@ -264,11 +264,6 @@ class ApiError(ExcludeEnumMixin, Enum, metaclass=ApiErrorFallback):
         ApiErrorType.USER_ERROR,
         ApiErrorLevel.ERROR,
     )
-    INVALID_MODEL_NAME = (
-        ApiErrorIdentifier.INVALID_MODEL_NAME,
-        ApiErrorType.USER_ERROR,
-        ApiErrorLevel.ERROR,
-    )
     INSUFFICIENT_SCOPES = (
         ApiErrorIdentifier.INSUFFICIENT_SCOPES,
         ApiErrorType.USER_ERROR,
@@ -304,6 +299,11 @@ class ApiError(ExcludeEnumMixin, Enum, metaclass=ApiErrorFallback):
         ApiErrorType.SERVER_ERROR,
         ApiErrorLevel.ERROR,
     )
+    INVALID_MODEL_NAME = (
+        ApiErrorIdentifier.INVALID_MODEL_NAME,
+        ApiErrorType.USER_ERROR,
+        ApiErrorLevel.ERROR,
+    )
     INVALID_PARAMETER = (
         ApiErrorIdentifier.INVALID_PARAMETER,
         ApiErrorType.SERVER_ERROR,

crypticorn/common/exceptions.py

@@ -5,7 +5,9 @@ from fastapi import HTTPException as FastAPIHTTPException, Request, FastAPI
 from fastapi.exceptions import RequestValidationError, ResponseValidationError
 from fastapi.responses import JSONResponse
 from crypticorn.common import ApiError, ApiErrorIdentifier, ApiErrorType, ApiErrorLevel
+import logging
 
+logger = logging.getLogger(__name__)
 
 class ExceptionType(StrEnum):
     HTTP = "http"
@@ -91,35 +93,39 @@ class WebSocketException(HTTPException):
 
 async def general_handler(request: Request, exc: Exception):
     """This is the default exception handler for all exceptions."""
-    body = ExceptionContent(message=str(exc), error=ApiError.UNKNOWN_ERROR)
+    body = ExceptionContent(message=str(exc), error=ApiError.UNKNOWN_ERROR).enrich()
+    logger.error(f"Unknown error: {body.detail}")
     return JSONResponse(
-        status_code=body.enrich().status_code, content=HTTPException(content=body).detail
+        status_code=body.status_code, content=HTTPException(content=body).detail
     )
 
 
 async def request_validation_handler(request: Request, exc: RequestValidationError):
     """This is the exception handler for all request validation errors."""
-    body = ExceptionContent(message=str(exc), error=ApiError.INVALID_DATA_REQUEST)
+    body = ExceptionContent(message=str(exc), error=ApiError.INVALID_DATA_REQUEST).enrich()
+    logger.error(f"Request validation error: {body.detail}")
     return JSONResponse(
-        status_code=body.enrich().status_code, content=HTTPException(content=body).detail
+        status_code=body.status_code, content=HTTPException(content=body).detail
     )
 
 
 async def response_validation_handler(request: Request, exc: ResponseValidationError):
     """This is the exception handler for all response validation errors."""
-    body = ExceptionContent(message=str(exc), error=ApiError.INVALID_DATA_RESPONSE)
+    body = ExceptionContent(message=str(exc), error=ApiError.INVALID_DATA_RESPONSE).enrich()
+    logger.error(f"Response validation error: {body.detail}")
     return JSONResponse(
-        status_code=body.enrich().status_code, content=HTTPException(content=body).detail
+        status_code=body.status_code, content=HTTPException(content=body).detail
     )
 
 
 async def http_handler(request: Request, exc: HTTPException):
     """This is the exception handler for HTTPExceptions. It unwraps the HTTPException and returns the detail in a flat JSON response."""
+    logger.error(f"HTTP error: {exc.detail}")
     return JSONResponse(status_code=exc.status_code, content=exc.detail)
 
 
 def register_exception_handlers(app: FastAPI):
-    """Utility to register serveral exception handlers in one go. Catches Exception, HTTPException and Data Validation errors and responds with a unified json body."""
+    """Utility to register serveral exception handlers in one go. Catches Exception, HTTPException and Data Validation errors, logs them and responds with a unified json body."""
     app.add_exception_handler(Exception, general_handler)
     app.add_exception_handler(FastAPIHTTPException, http_handler)
     app.add_exception_handler(RequestValidationError, request_validation_handler)

{crypticorn-2.7.3.dist-info → crypticorn-2.7.5.dist-info}/METADATA

@@ -1,8 +1,9 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.7.3
+Version: 2.7.5
 Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
+License: MIT
 Project-URL: Homepage, https://crypticorn.com
 Keywords: machine learning,data science,crypto,modelling
 Classifier: Topic :: Scientific/Engineering
@@ -24,6 +25,8 @@ Requires-Dist: typing-extensions<5.0.0,>=4.7.1
 Requires-Dist: requests<3.0.0,>=2.32.0
 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"
@@ -40,17 +43,12 @@ Requires-Dist: PyJWT==2.10.0; extra == "test"
 Provides-Extra: extra
 Requires-Dist: pandas<3.0.0,>=2.2.0; extra == "extra"
 
-# What is Crypticorn?
+## What is Crypticorn?
 
-Crypticorn is at the forefront of cutting-edge artificial intelligence cryptocurrency trading.
-Crypticorn offers AI-based solutions for both active and passive investors, including:
- - Prediction Dashboard with trading terminal,
- - AI Agents with different strategies,
- - DEX AI Signals for newly launched tokens,
- - DEX AI Bots
+Crypticorn is at the forefront of cutting-edge crypto trading with Machine Learning.
 
-Use this API Client to contribute to the so-called Hive AI, a community driven AI Meta Model for predicting the
-cryptocurrency market.
+Use this API Client to access valuable data sources, contribute to the Hive AI - a community driven AI Meta Model for predicting the
+crypto market - and programmatically interact with the entire Crypticorn ecosystem.
 
 ## Installation
 
@@ -66,17 +64,19 @@ If you want the latest version, which could be a pre release, run:
 pip install --pre crypticorn
 ```
 
+You can install extra dependencies grouped in the extras `extra` (heavy dependencies that do not come with the default version) `dev` (development) and `test` (testing). The `extra` dependencies include heavy libraries like `pandas`, which is only used in a few custom API operations (suffixed with `_fmt`), which preprocess the response data as a pandas Dataframe for convenience.
+
 ## Structure
 
 Our API is available as an asynchronous Python SDK. The main entry point you need is the `ApiClient` class, which you would import like this:
 ```python
 from crypticorn import ApiClient
 ```
-The ApiClient serves as the central interface for API operations. It instantiates multiple API wrappers corresponding to our microservices.
+The ApiClient serves as the central interface for API operations. It instantiates multiple API wrappers corresponding to our micro services.
 
-Specific imports, such as request models, should be accessed through the appropriate submodules.
+Request and response models for API operations should be accessed through the appropriate sub package.
 
-Note: All symbols are re-exported at the first submodule layer for convenience.
+Note: All symbols are re-exported at the sub package level for convenience.
 
 ```python
 from crypticorn.trade import BotStatus
@@ -87,6 +87,10 @@ The `common` submodule contains shared classes not bound to a specific API.
 from crypticorn.common import Scope, Exchange
 ```
 
+## Authentication
+
+To get started, [create an API key in your dashboard](https://app.crypticorn.com/account/developer). Then instantiate the `ApiClient` class with your copied key.
+
 ## Basic Usage
 
 ### With Async Context Protocol
@@ -131,16 +135,16 @@ print(res)
 ```
 The output would look like this:
 ```python
-status_code=200 headers={'Date': 'Wed, 09 Apr 2025 19:15:19 GMT', 'Content-Type': 'application/json', 'Transfer-Encoding': 'chunked', 'Connection': 'keep-alive', 'Alt-Svc': 'h3=":443"; ma=86400', 'Server': 'cloudflare', 'Cf-Cache-Status': 'DYNAMIC', 'Content-Encoding': 'gzip', 'CF-RAY': '92dc551a687bbe5e-ZRH'} data=[ProductModel(id='67e8146e7bae32f3838fe36a', name='Awesome Product', price=5.0, scopes=None, duration=30, description='You need to buy this', is_active=True)] raw_data=b'[{"id":"67e8146e7bae32f3838fe36a","name":"Awesome Product","price":5.0,"duration":30,"description":"You need to buy this","is_active":true}]'
+status_code=200 headers={'Date': 'Wed, 09 Apr 2025 19:15:19 GMT', 'Content-Type': 'application/json'} data=[ProductModel(id='67e8146e7bae32f3838fe36a', name='Awesome Product', price=5.0, scopes=None, duration=30, description='You need to buy this', is_active=True)] raw_data=b'[{"id":"67e8146e7bae32f3838fe36a","name":"Awesome Product","price":5.0,"duration":30,"description":"You need to buy this","is_active":true}]'
 ```
-You can then access the data of the response (as serialized output) with:
+You can then access the data of the response (as serialized output (1) or as JSON string in bytes (2)) with:
 ```python
 print(res.data)
+print(res.raw_data)
 ```
 On top of that you get some information about the request:
 ```python
 print(res.status_code)
-print(res.raw_data)
 print(res.headers)
 ```
 
@@ -163,6 +167,7 @@ This might be of use if you are testing a specific API locally.
 To override e.g. the host for the Hive client to connect to http://localhost:8000 instead of the default proxy, you would do:
 ```python
 from crypticorn.hive import Configuration as Hiveconfig
+from crypticorn.common import Service
 async with ApiClient(base_url=BaseUrl.DEV) as client:
-        client.configure(config=HiveConfig(host="http://localhost:8000"), client=client.hive)
+        client.configure(config=HiveConfig(host="http://localhost:8000"), client=Service.HIVE)
 ```

{crypticorn-2.7.3.dist-info → crypticorn-2.7.5.dist-info}/RECORD

@@ -58,14 +58,17 @@ crypticorn/auth/client/models/whoami200_response.py,sha256=-Kj3fB4lgNaa8v_LTertj
 crypticorn/cli/__init__.py,sha256=bgMmlpRThjYcxXJ1U3UmLE8ODVT5olmFY1u69VOjthQ,69
 crypticorn/cli/__main__.py,sha256=x9T4xS3U-qokGEzad7rTujmq4yjV5xcYSXgNsDFkvyo,253
 crypticorn/cli/init.py,sha256=xefvOCjXOiSUPWHFDDv7DWDC0Ggs1JKxk7KPCXyMZnU,3729
+crypticorn/cli/templates/Dockerfile,sha256=89KlphaXJH51L7Vs4B928WmwYcMtpvLmKGyoDAhOcMw,726
 crypticorn/cli/templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 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/decorators.py,sha256=pmnGYCIrLv59wZkDbvPyK9NJmgPJWW74LXTdIWSjOkY,1063
 crypticorn/common/enums.py,sha256=RitDVqlG_HTe6tHT6bWusZNFCeYk1eQvJVH-7x3_Zlg,668
-crypticorn/common/errors.py,sha256=K1VSEKZro1I4cmi-sOhx24pTrvhbbD4RBRRqKodWpA8,27851
-crypticorn/common/exceptions.py,sha256=2gsYU0AMiLga4D99PBprQX59k12jJJMlUZ0uEk9rQxs,5671
+crypticorn/common/errors.py,sha256=8jxZ2lLn_NoFKKq6n2JwKPsR0dA2vkGnbXDfEK6ndH0,27851
+crypticorn/common/exceptions.py,sha256=FOxScGTnAoiBkpC5lccQ6_b1jIPcWxawZvR_H2KBCNY,5953
 crypticorn/common/mixins.py,sha256=LKPcNTR8uREeDGWTlWozNx7rS1mYdQVx1RllLhxIAsE,1640
 crypticorn/common/pagination.py,sha256=c07jrMNrBaNTmgx4sppdP7ND4RNT7NBqBXWvofazIlE,2251
 crypticorn/common/scopes.py,sha256=gbxrzME18ASQS18IHg96TvFZxh5-O8ffD2caGpfs0lc,2333
@@ -221,8 +224,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.3.dist-info/METADATA,sha256=t3vla6kYBXY_bkb-HZrZN5EOagTwHt7KLRYcgCFHc50,6249
-crypticorn-2.7.3.dist-info/WHEEL,sha256=GHB6lJx2juba1wDgXDNlMTyM13ckjBMKf-OnwgKOCtA,91
-crypticorn-2.7.3.dist-info/entry_points.txt,sha256=d_xHsGvUTebPveVUK0SrpDFQ5ZRSjlI7lNCc11sn2PM,59
-crypticorn-2.7.3.dist-info/top_level.txt,sha256=EP3NY216qIBYfmvGl0L2Zc9ItP0DjGSkiYqd9xJwGcM,11
-crypticorn-2.7.3.dist-info/RECORD,,
+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.7.3.dist-info → crypticorn-2.7.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.3.0)
+Generator: setuptools (80.3.1)
 Root-Is-Purelib: true
 Tag: py3-none-any