crypticorn 2.9.0rc1__py3-none-any.whl → 2.10.0__py3-none-any.whl

crypticorn/cli/__init__.py

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

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/cli/init.py

@@ -4,7 +4,6 @@ import subprocess
 import importlib.resources
 import crypticorn.cli.templates as templates
 
-
 def get_git_root() -> Path:
     """Get the root directory of the git repository."""
     try:
@@ -30,6 +29,12 @@ 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():
@@ -61,8 +66,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 +84,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 +109,16 @@ 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/cli/templates/merge-env.sh

@@ -0,0 +1,13 @@
+#!/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)
+
+# 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/cli/version.py

@@ -0,0 +1,7 @@
+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/common/openapi.py

@@ -1,11 +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.",
-        }
-    ]
-
+    {
+        "name": "Status",
+        "description": "These endpoints contain status operations.",
+    },
+    {
+        "name": "Admin",
+        "description": "These endpoints contain debugging and monitoring operations. They require admin scopes.",
+    },
+]

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/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/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

crypticorn/hive/client/api/admin_api.py

@@ -16,8 +16,8 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
 from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
-from pydantic import Field, StrictInt, StrictStr, field_validator
-from typing import Any, Dict, List, Optional
+from pydantic import Field, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, Dict, List, Optional, Union
 from typing_extensions import Annotated
 from crypticorn.hive.client.models.log_level import LogLevel
 
@@ -271,7 +271,7 @@ class AdminApi:
         include: Annotated[
             Optional[List[StrictStr]],
             Field(
-                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."
             ),
         ] = None,
         _request_timeout: Union[
@@ -285,12 +285,12 @@ class AdminApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[object]:
+    ) -> Dict[str, str]:
         """List Installed Packages
 
-        Return a list of installed packages and versions.
+        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
 
-        :param include: List of dependencies to include in the response. If not provided, all installed packages will be returned.
+        :param include: List of regex patterns to match against package names. If not provided, all installed packages will be returned.
         :type include: List[str]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -323,7 +323,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[object]",
+            "200": "Dict[str, str]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -340,7 +340,7 @@ class AdminApi:
         include: Annotated[
             Optional[List[StrictStr]],
             Field(
-                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."
             ),
         ] = None,
         _request_timeout: Union[
@@ -354,12 +354,12 @@ class AdminApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[object]]:
+    ) -> ApiResponse[Dict[str, str]]:
         """List Installed Packages
 
-        Return a list of installed packages and versions.
+        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
 
-        :param include: List of dependencies to include in the response. If not provided, all installed packages will be returned.
+        :param include: List of regex patterns to match against package names. If not provided, all installed packages will be returned.
         :type include: List[str]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -392,7 +392,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[object]",
+            "200": "Dict[str, str]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -409,7 +409,7 @@ class AdminApi:
         include: Annotated[
             Optional[List[StrictStr]],
             Field(
-                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."
             ),
         ] = None,
         _request_timeout: Union[
@@ -426,9 +426,9 @@ class AdminApi:
     ) -> RESTResponseType:
         """List Installed Packages
 
-        Return a list of installed packages and versions.
+        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
 
-        :param include: List of dependencies to include in the response. If not provided, all installed packages will be returned.
+        :param include: List of regex patterns to match against package names. If not provided, all installed packages will be returned.
         :type include: List[str]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -461,7 +461,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[object]",
+            "200": "Dict[str, str]",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -541,9 +541,9 @@ class AdminApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> LogLevel:
-        """Get Logging Level
+        """(Deprecated) Get Logging Level
 
-        Get the log level of the server logger.
+        Get the log level of the server logger. Will be removed in a future release.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -566,6 +566,7 @@ class AdminApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """  # noqa: E501
+        warnings.warn("GET /admin/log-level is deprecated.", DeprecationWarning)
 
         _param = self._get_log_level_serialize(
             _request_auth=_request_auth,
@@ -601,9 +602,9 @@ class AdminApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[LogLevel]:
-        """Get Logging Level
+        """(Deprecated) Get Logging Level
 
-        Get the log level of the server logger.
+        Get the log level of the server logger. Will be removed in a future release.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -626,6 +627,7 @@ class AdminApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """  # noqa: E501
+        warnings.warn("GET /admin/log-level is deprecated.", DeprecationWarning)
 
         _param = self._get_log_level_serialize(
             _request_auth=_request_auth,
@@ -661,9 +663,9 @@ class AdminApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Get Logging Level
+        """(Deprecated) Get Logging Level
 
-        Get the log level of the server logger.
+        Get the log level of the server logger. Will be removed in a future release.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -686,6 +688,7 @@ class AdminApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """  # noqa: E501
+        warnings.warn("GET /admin/log-level is deprecated.", DeprecationWarning)
 
         _param = self._get_log_level_serialize(
             _request_auth=_request_auth,
@@ -767,7 +770,7 @@ class AdminApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> int:
+    ) -> float:
         """Get Memory Usage
 
         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.
@@ -802,7 +805,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "int",
+            "200": "float",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -827,7 +830,7 @@ class AdminApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[int]:
+    ) -> ApiResponse[float]:
         """Get Memory Usage
 
         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.
@@ -862,7 +865,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "int",
+            "200": "float",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout
@@ -922,7 +925,7 @@ class AdminApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "int",
+            "200": "float",
         }
         response_data = await self.api_client.call_api(
             *_param, _request_timeout=_request_timeout

crypticorn/hive/client/api/data_api.py

@@ -44,14 +44,20 @@ class DataApi:
     @validate_call
     async def download_data(
         self,
-        model_id: Annotated[StrictInt, Field(description="Model ID")],
+        model_id: Annotated[
+            StrictInt, Field(description="The ID of the model to download data for.")
+        ],
         version: Annotated[
             Optional[DataVersion],
-            Field(description="Data version. Default is the latest public version."),
+            Field(
+                description="The version of the data to download. Default is the latest public version."
+            ),
         ] = None,
         feature_size: Annotated[
             Optional[FeatureSize],
-            Field(description="The number of features in the data. Default is LARGE."),
+            Field(
+                description="The number of features in the data. Default is `LARGE`."
+            ),
         ] = None,
         _request_timeout: Union[
             None,
@@ -69,11 +75,11 @@ class DataApi:
 
         Get download links for model training data
 
-        :param model_id: Model ID (required)
+        :param model_id: The ID of the model to download data for. (required)
         :type model_id: int
-        :param version: Data version. Default is the latest public version.
+        :param version: The version of the data to download. Default is the latest public version.
         :type version: DataVersion
-        :param feature_size: The number of features in the data. Default is LARGE.
+        :param feature_size: The number of features in the data. Default is `LARGE`.
         :type feature_size: FeatureSize
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -122,14 +128,20 @@ class DataApi:
     @validate_call
     async def download_data_with_http_info(
         self,
-        model_id: Annotated[StrictInt, Field(description="Model ID")],
+        model_id: Annotated[
+            StrictInt, Field(description="The ID of the model to download data for.")
+        ],
         version: Annotated[
             Optional[DataVersion],
-            Field(description="Data version. Default is the latest public version."),
+            Field(
+                description="The version of the data to download. Default is the latest public version."
+            ),
         ] = None,
         feature_size: Annotated[
             Optional[FeatureSize],
-            Field(description="The number of features in the data. Default is LARGE."),
+            Field(
+                description="The number of features in the data. Default is `LARGE`."
+            ),
         ] = None,
         _request_timeout: Union[
             None,
@@ -147,11 +159,11 @@ class DataApi:
 
         Get download links for model training data
 
-        :param model_id: Model ID (required)
+        :param model_id: The ID of the model to download data for. (required)
         :type model_id: int
-        :param version: Data version. Default is the latest public version.
+        :param version: The version of the data to download. Default is the latest public version.
         :type version: DataVersion
-        :param feature_size: The number of features in the data. Default is LARGE.
+        :param feature_size: The number of features in the data. Default is `LARGE`.
         :type feature_size: FeatureSize
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -200,14 +212,20 @@ class DataApi:
     @validate_call
     async def download_data_without_preload_content(
         self,
-        model_id: Annotated[StrictInt, Field(description="Model ID")],
+        model_id: Annotated[
+            StrictInt, Field(description="The ID of the model to download data for.")
+        ],
         version: Annotated[
             Optional[DataVersion],
-            Field(description="Data version. Default is the latest public version."),
+            Field(
+                description="The version of the data to download. Default is the latest public version."
+            ),
         ] = None,
         feature_size: Annotated[
             Optional[FeatureSize],
-            Field(description="The number of features in the data. Default is LARGE."),
+            Field(
+                description="The number of features in the data. Default is `LARGE`."
+            ),
         ] = None,
         _request_timeout: Union[
             None,
@@ -225,11 +243,11 @@ class DataApi:
 
         Get download links for model training data
 
-        :param model_id: Model ID (required)
+        :param model_id: The ID of the model to download data for. (required)
         :type model_id: int
-        :param version: Data version. Default is the latest public version.
+        :param version: The version of the data to download. Default is the latest public version.
         :type version: DataVersion
-        :param feature_size: The number of features in the data. Default is LARGE.
+        :param feature_size: The number of features in the data. Default is `LARGE`.
         :type feature_size: FeatureSize
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request