crypticorn 2.11.0__tar.gz → 2.11.4__tar.gz

{crypticorn-2.11.0 → crypticorn-2.11.4}/CHANGELOG.md

@@ -1,6 +1,66 @@
 # CHANGELOG
 
 
+## v2.11.4 (2025-05-15)
+
+### Bug Fixes
+
+- Fixes dist build
+  ([`3913bd7`](https://github.com/crypticorn-ai/api-client/commit/3913bd74a12d50727197efe72a68f36c9165c068))
+
+
+## v2.11.3 (2025-05-15)
+
+### Bug Fixes
+
+- Fixes ci permission error copying static folder to dist
+  ([`10f801b`](https://github.com/crypticorn-ai/api-client/commit/10f801b6f760c3f7de12fe830f9d3dc6895dde67))
+
+
+## v2.11.2 (2025-05-15)
+
+### Bug Fixes
+
+- Fixes ohlc dataframe response
+  ([`a334782`](https://github.com/crypticorn-ai/api-client/commit/a33478251a80e6255a9d4c0a2c43d701403c3399))
+
+
+## v2.11.1 (2025-05-15)
+
+### Bug Fixes
+
+- Fixes dataframe conversion for get_available_exchanges_fmt
+  ([`4c85d67`](https://github.com/crypticorn-ai/api-client/commit/4c85d67386fbda1b50a237df10a10a8eb2fb3531))
+
+### Build System
+
+- Include static files in dist
+  ([`1b07130`](https://github.com/crypticorn-ai/api-client/commit/1b071302cb2f15f086b7812152cde8d425c2de9d))
+
+### Continuous Integration
+
+- Run test only on dev/main
+  ([`dcc59e1`](https://github.com/crypticorn-ai/api-client/commit/dcc59e16e8138761c76da0cc936db7738058ac19))
+
+### Documentation
+
+- Document scope structure
+  ([`fe0dca0`](https://github.com/crypticorn-ai/api-client/commit/fe0dca0d41ce79d0c1809a3d457a52a182cf37c4))
+
+- Update docstring example `configure` method
+  ([`30f59b3`](https://github.com/crypticorn-ai/api-client/commit/30f59b37b5fe3ae8f22ee0a5e72e9a7274dee23c))
+
+### Refactoring
+
+- Make merge-env script template more robust
+  ([`1314f71`](https://github.com/crypticorn-ai/api-client/commit/1314f718fd4299a37e55424b3ea14c573f746aeb))
+
+### Testing
+
+- Add expiration to test api keys
+  ([`2e4044f`](https://github.com/crypticorn-ai/api-client/commit/2e4044f05caa2ae35fe9cadc05eeed8f65d0049b))
+
+
 ## v2.11.0 (2025-05-13)
 
 ### Bug Fixes

{crypticorn-2.11.0 → crypticorn-2.11.4}/MANIFEST.in

@@ -2,4 +2,4 @@ graft crypticorn/cli/templates
 include CHANGELOG.md
 include README.md
 include LICENSE
-include static
+graft static

{crypticorn-2.11.0/crypticorn.egg-info → crypticorn-2.11.4}/PKG-INFO

@@ -1,23 +1,9 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.11.0
+Version: 2.11.4
 Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
-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.
+License-Expression: MIT
 Project-URL: Homepage, https://crypticorn.com
 Project-URL: Documentation, https://docs.crypticorn.com
 Project-URL: Dashboard, https://app.crypticorn.com
@@ -26,7 +12,6 @@ Classifier: Topic :: Scientific/Engineering
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -99,7 +84,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="pip-structure.svg" alt="pip package structure" />
+<img src="static/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).
 
@@ -116,7 +101,12 @@ 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.
+To get started, [create an API key in your dashboard](https://app.crypticorn.com/account/developer). 
+
+The scopes you can assign, resemble the [package structure](#structure). The first part defines if the scopes is for reading or writing a ressource, the second matches the API, the third the ROUTER being used. `read` scopes gives access to GET, `write` to PUT, PATCH, POST, DELETE endpoints. 
+
+There are scopes which don't follow this structure. Those are either scopes that must be purchased (e.g. `read:predictions`), give access to endpoints existing in all APIs (e.g. `read:admin`) or provide access to an entire service (e.g. `read:sentiment`).
+
 
 ## Basic Usage
 

{crypticorn-2.11.0 → crypticorn-2.11.4}/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="pip-structure.svg" alt="pip package structure" />
+<img src="static/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).
 
@@ -46,7 +46,12 @@ 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.
+To get started, [create an API key in your dashboard](https://app.crypticorn.com/account/developer). 
+
+The scopes you can assign, resemble the [package structure](#structure). The first part defines if the scopes is for reading or writing a ressource, the second matches the API, the third the ROUTER being used. `read` scopes gives access to GET, `write` to PUT, PATCH, POST, DELETE endpoints. 
+
+There are scopes which don't follow this structure. Those are either scopes that must be purchased (e.g. `read:predictions`), give access to endpoints existing in all APIs (e.g. `read:admin`) or provide access to an entire service (e.g. `read:sentiment`).
+
 
 ## Basic Usage
 

{crypticorn-2.11.0 → crypticorn-2.11.4}/crypticorn/auth/client/configuration.py

@@ -195,7 +195,7 @@ class Configuration:
         debug: Optional[bool] = None,
     ) -> None:
         """Constructor"""
-        self._base_path = "http://localhost/v1/auth" if host is None else host
+        self._base_path = "https://api.crypticorn.dev/v1/auth" 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
@@ -528,7 +528,7 @@ class Configuration:
         """
         return [
             {
-                "url": "http://localhost/v1/auth",
+                "url": "https://api.crypticorn.dev/v1/auth",
                 "description": "No description provided",
             }
         ]

{crypticorn-2.11.0 → crypticorn-2.11.4}/crypticorn/auth/client/models/create_api_key_request.py

@@ -78,12 +78,13 @@ class CreateApiKeyRequest(BaseModel):
                     "read:metrics:tokens",
                     "read:metrics:markets",
                     "read:sentiment",
+                    "read:klines",
                     "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', 'read:admin', 'write:admin')"
+                    "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:klines', 'read:admin', 'write:admin')"
                 )
         return value
 

{crypticorn-2.11.0 → crypticorn-2.11.4}/crypticorn/auth/client/models/get_api_keys200_response_inner.py

@@ -86,12 +86,13 @@ class GetApiKeys200ResponseInner(BaseModel):
                     "read:metrics:tokens",
                     "read:metrics:markets",
                     "read:sentiment",
+                    "read:klines",
                     "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', 'read:admin', 'write:admin')"
+                    "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:klines', 'read:admin', 'write:admin')"
                 )
         return value
 

{crypticorn-2.11.0 → crypticorn-2.11.4}/crypticorn/cli/templates/merge-env.sh

@@ -1,17 +1,15 @@
 #!/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
+# add this after checkout before copying files to the host
 
 set -e
 
 cp .env.example .env
 echo >> .env
-printenv | awk -F= '{print $1"=\""substr($0, index($0,$2))"\""}' >> .env
+echo "# Environment variables" >> .env
+printenv | awk -F= '/^[a-zA-Z_][a-zA-Z0-9_]*=/{print $1"=\""substr($0, index($0,$2))"\""}' | sort | uniq >> .env

{crypticorn-2.11.0 → crypticorn-2.11.4}/crypticorn/client.py

@@ -119,8 +119,8 @@ class ApiClient:
         :param service: The service to configure.
 
         Example:
-        >>> async with ApiClient(base_url=BaseUrl.DEV, jwt=jwt) as client:
-        >>>     client.configure(config=HiveConfig(host="http://localhost:8000"), client=client.hive)
+        >>> async with ApiClient() as client:
+        ...     client.configure(config=HiveConfig(host="http://localhost:8000"), service=Service.HIVE)
         """
         assert Service.validate(service), f"Invalid service: {service}"
         client = self._services[service]

{crypticorn-2.11.0 → crypticorn-2.11.4}/crypticorn/common/ansi_colors.py

@@ -3,6 +3,7 @@ try:
 except ImportError:
     from strenum import StrEnum
 
+
 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."""
 

{crypticorn-2.11.0 → crypticorn-2.11.4}/crypticorn/common/auth.py

@@ -19,6 +19,7 @@ from fastapi.security import (
 )
 from typing_extensions import Annotated
 from typing import Union
+
 # Auth Schemes
 http_bearer = HTTPBearer(
     bearerFormat="JWT",
@@ -160,9 +161,7 @@ class AuthHandler:
         bearer: Annotated[
             Union[HTTPAuthorizationCredentials, None], Depends(http_bearer)
         ] = None,
-        api_key: Annotated[
-            Union[str, None], Depends(apikey_header)
-        ] = None,
+        api_key: Annotated[Union[str, None], Depends(apikey_header)] = None,
         sec: SecurityScopes = SecurityScopes(),
     ) -> Verify200Response:
         """

{crypticorn-2.11.0 → crypticorn-2.11.4}/crypticorn/common/errors.py

@@ -3,6 +3,7 @@
 from enum import Enum
 from fastapi import status
 from crypticorn.common.mixins import ApiErrorFallback
+
 try:
     from enum import StrEnum
 except ImportError:

{crypticorn-2.11.0 → crypticorn-2.11.4}/crypticorn/common/exceptions.py

@@ -6,6 +6,7 @@ from fastapi.responses import JSONResponse
 from crypticorn.common import ApiError, ApiErrorIdentifier, ApiErrorType, ApiErrorLevel
 import logging
 import json
+
 try:
     from enum import StrEnum
 except ImportError:

{crypticorn-2.11.0 → crypticorn-2.11.4}/crypticorn/common/scopes.py

@@ -55,6 +55,9 @@ class Scope(StrEnum):
     # Sentiment scopes
     READ_SENTIMENT = "read:sentiment"
 
+    # Klines scopes
+    READ_KLINES = "read:klines"
+
     @classmethod
     def admin_scopes(cls) -> list["Scope"]:
         """Scopes that are only available to admins."""
@@ -77,4 +80,11 @@ class Scope(StrEnum):
         """Scopes that can be purchased."""
         return [
             cls.READ_PREDICTIONS,
+            cls.READ_METRICS_MARKETCAP,
+            cls.READ_METRICS_INDICATORS,
+            cls.READ_METRICS_EXCHANGES,
+            cls.READ_METRICS_TOKENS,
+            cls.READ_METRICS_MARKETS,
+            cls.READ_KLINES,
+            cls.READ_SENTIMENT,
         ]

{crypticorn-2.11.0 → crypticorn-2.11.4}/crypticorn/common/warnings.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 from typing import Union
 
+
 class CrypticornDeprecationWarning(DeprecationWarning):
     """A Crypticorn specific deprecation warning.
 

{crypticorn-2.11.0 → crypticorn-2.11.4}/crypticorn/klines/main.py

@@ -65,7 +65,19 @@ class OHLCVDataApiWrapper(OHLCVDataApi):
         """
         pd = optional_import("pandas", "extra")
         response = await self.get_ohlcv(*args, **kwargs)
-        return pd.DataFrame(response)
+        rows = []
+        for item in response:
+            row = {
+                'timestamp': item.timestamp,
+                'open': item.open,
+                'high': item.high,
+                'low': item.low,
+                'close': item.close,
+                'volume': item.volume
+            }
+            rows.append(row)  
+        df = pd.DataFrame(rows)
+        return df
 
 
 class SymbolsApiWrapper(SymbolsApi):

{crypticorn-2.11.0 → crypticorn-2.11.4}/crypticorn/metrics/client/__init__.py

@@ -43,11 +43,15 @@ from crypticorn.metrics.client.models.api_error_identifier import ApiErrorIdenti
 from crypticorn.metrics.client.models.api_error_level import ApiErrorLevel
 from crypticorn.metrics.client.models.api_error_type import ApiErrorType
 from crypticorn.metrics.client.models.exception_detail import ExceptionDetail
+from crypticorn.metrics.client.models.exchange_availability import ExchangeAvailability
 from crypticorn.metrics.client.models.exchange_mapping import ExchangeMapping
 from crypticorn.metrics.client.models.internal_exchange import InternalExchange
 from crypticorn.metrics.client.models.log_level import LogLevel
 from crypticorn.metrics.client.models.market_type import MarketType
 from crypticorn.metrics.client.models.marketcap_ranking import MarketcapRanking
+from crypticorn.metrics.client.models.marketcap_symbol_ranking import (
+    MarketcapSymbolRanking,
+)
 from crypticorn.metrics.client.models.ohlcv import OHLCV
 from crypticorn.metrics.client.models.severity import Severity
 from crypticorn.metrics.client.models.time_interval import TimeInterval

{crypticorn-2.11.0 → crypticorn-2.11.4}/crypticorn/metrics/client/api/exchanges_api.py

@@ -17,8 +17,9 @@ from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
 from pydantic import Field, StrictInt, StrictStr
-from typing import Any, Dict, List, Optional
+from typing import List, Optional
 from typing_extensions import Annotated
+from crypticorn.metrics.client.models.exchange_availability import ExchangeAvailability
 from crypticorn.metrics.client.models.exchange_mapping import ExchangeMapping
 from crypticorn.metrics.client.models.internal_exchange import InternalExchange
 from crypticorn.metrics.client.models.market_type import MarketType
@@ -88,7 +89,7 @@ class ExchangesApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[Dict[str, object]]:
+    ) -> List[ExchangeAvailability]:
         """Get Available Exchanges
 
         Get available exchanges for a symbol with various filtering options.
@@ -144,7 +145,7 @@ class ExchangesApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[Dict[str, object]]",
+            "200": "List[ExchangeAvailability]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -201,7 +202,7 @@ class ExchangesApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[Dict[str, object]]]:
+    ) -> ApiResponse[List[ExchangeAvailability]]:
         """Get Available Exchanges
 
         Get available exchanges for a symbol with various filtering options.
@@ -257,7 +258,7 @@ class ExchangesApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[Dict[str, object]]",
+            "200": "List[ExchangeAvailability]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -370,7 +371,7 @@ class ExchangesApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[Dict[str, object]]",
+            "200": "List[ExchangeAvailability]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout

{crypticorn-2.11.0 → crypticorn-2.11.4}/crypticorn/metrics/client/api/indicators_api.py

@@ -44,7 +44,9 @@ class IndicatorsApi:
         symbol: Annotated[
             StrictStr, Field(description="Symbol to fetch KER indicator for")
         ],
-        market: Annotated[Optional[MarketType], Field(description="Market")] = None,
+        market: Annotated[
+            Optional[MarketType], Field(description="Market. Defaults to futures.")
+        ] = None,
         period: Annotated[
             Optional[StrictInt], Field(description="KER indicator period")
         ] = None,
@@ -70,7 +72,7 @@ class IndicatorsApi:
 
         :param symbol: Symbol to fetch KER indicator for (required)
         :type symbol: str
-        :param market: Market
+        :param market: Market. Defaults to futures.
         :type market: MarketType
         :param period: KER indicator period
         :type period: int
@@ -127,7 +129,9 @@ class IndicatorsApi:
         symbol: Annotated[
             StrictStr, Field(description="Symbol to fetch KER indicator for")
         ],
-        market: Annotated[Optional[MarketType], Field(description="Market")] = None,
+        market: Annotated[
+            Optional[MarketType], Field(description="Market. Defaults to futures.")
+        ] = None,
         period: Annotated[
             Optional[StrictInt], Field(description="KER indicator period")
         ] = None,
@@ -153,7 +157,7 @@ class IndicatorsApi:
 
         :param symbol: Symbol to fetch KER indicator for (required)
         :type symbol: str
-        :param market: Market
+        :param market: Market. Defaults to futures.
         :type market: MarketType
         :param period: KER indicator period
         :type period: int
@@ -210,7 +214,9 @@ class IndicatorsApi:
         symbol: Annotated[
             StrictStr, Field(description="Symbol to fetch KER indicator for")
         ],
-        market: Annotated[Optional[MarketType], Field(description="Market")] = None,
+        market: Annotated[
+            Optional[MarketType], Field(description="Market. Defaults to futures.")
+        ] = None,
         period: Annotated[
             Optional[StrictInt], Field(description="KER indicator period")
         ] = None,
@@ -236,7 +242,7 @@ class IndicatorsApi:
 
         :param symbol: Symbol to fetch KER indicator for (required)
         :type symbol: str
-        :param market: Market
+        :param market: Market. Defaults to futures.
         :type market: MarketType
         :param period: KER indicator period
         :type period: int