craft-ai-sdk 0.50.1rc2__tar.gz → 0.51.0rc1__tar.gz

{craft_ai_sdk-0.50.1rc2 → craft_ai_sdk-0.51.0rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: craft-ai-sdk
-Version: 0.50.1rc2
+Version: 0.51.0rc1
 Summary: Craft AI MLOps platform SDK
 Home-page: https://www.craft.ai/
 License: Apache-2.0

{craft_ai_sdk-0.50.1rc2 → craft_ai_sdk-0.51.0rc1}/craft_ai_sdk/__init__.py

@@ -14,4 +14,4 @@ from .io import (  # noqa: F401
 )
 
 
-__version__ = "0.50.1rc2"
+__version__ = "0.51.0rc1"

{craft_ai_sdk-0.50.1rc2 → craft_ai_sdk-0.51.0rc1}/craft_ai_sdk/core/pipelines.py

@@ -10,6 +10,7 @@ from ..utils import (
     multipartify,
     handle_data_store_response,
     remove_keys_from_dict,
+    _datetime_to_timestamp_in_ms,
 )
 from .steps import (
     _add_inputs_outputs_in_message,
@@ -219,7 +220,7 @@ def create_pipeline(
         outputs,
         pipeline_name=pipeline_name,
     )
-    files = _prepare_create_step_files(container_config, data, function_path)
+    files = _prepare_create_step_files(sdk, container_config, data, function_path)
 
     log_action(
         sdk,
@@ -414,3 +415,47 @@ def download_pipeline_local_folder(sdk: BaseCraftAiSdk, pipeline_name, folder):
             f.write(object_content)
     else:
         raise ValueError("'folder' must be a string")
+
+
+@log_func_result("Pipeline logs")
+def get_pipeline_logs(
+    sdk: BaseCraftAiSdk,
+    pipeline_name,
+    from_datetime=None,
+    to_datetime=None,
+    limit=None,
+):
+    """Get the logs of a pipeline.
+
+    Args:
+        pipeline_name (:obj:`str`): Name of the pipeline.
+        from_datetime (:obj:`datetime.time`, optional): Datetime from which the logs
+            are collected.
+        to_datetime (:obj:`datetime.time`, optional): Datetime until which the logs
+            are collected.
+        limit (:obj:`int`, optional): Maximum number of logs that are collected.
+
+    Returns:
+        :obj:`list` of :obj:`dict`: List of collected logs represented as dict with
+        the following keys:
+
+        * ``"timestamp"`` (:obj:`str`): Timestamp of the log.
+        * ``"message"`` (:obj:`str`): Log message.
+    """
+    url = f"{sdk.base_environment_api_url}/pipelines/{pipeline_name}/logs"
+
+    data = {}
+    if from_datetime is not None:
+        data["from"] = _datetime_to_timestamp_in_ms(from_datetime)
+    if to_datetime is not None:
+        data["to"] = _datetime_to_timestamp_in_ms(to_datetime)
+    if limit is not None:
+        data["limit"] = limit
+
+    log_action(
+        sdk,
+        "Please wait while logs are being fetched. This may take a while...",
+    )
+    logs = sdk._post(url, json=data)
+
+    return logs

{craft_ai_sdk-0.50.1rc2 → craft_ai_sdk-0.51.0rc1}/craft_ai_sdk/core/steps.py

@@ -14,6 +14,7 @@ from ..utils import (
     multipartify,
     remove_none_values,
     handle_data_store_response,
+    _datetime_to_timestamp_in_ms,
 )
 from ..constants import CREATION_REQUESTS_RETRY_INTERVAL
 
@@ -73,17 +74,30 @@ def _prepare_create_step_data(
     return data
 
 
-def _prepare_create_step_files(container_config, data, function_path):
-    files = {}
-    if container_config.get("local_folder") is not None:
-        included = list(data.get("container_config", {}).get("included_folders", ["/"]))
-        included.append(data.get("container_config", {}).get("requirements_path"))
-        included.append(function_path)
-        tar_data = _compress_folder_to_memory(
-            container_config["local_folder"], include=list(filter(None, included))
-        )
-        files["step_file"] = tar_data
-    return files
+def _prepare_create_step_files(sdk, container_config, data, function_path):
+    if "local_folder" not in container_config:
+        return {}
+
+    url = f"{sdk.base_environment_api_url}/project-information"
+    project_information = sdk._get(url)
+
+    included = [
+        *(
+            data.get("container_config", {}).get(
+                "included_folders", project_information.get("included_folders")
+            )
+            or []
+        ),
+        data.get("container_config", {}).get(
+            "requirements_path", project_information.get("requirements_path")
+        ),
+        function_path,
+    ]
+
+    tar_data = _compress_folder_to_memory(
+        container_config["local_folder"], include=list(filter(None, included))
+    )
+    return {"step_file": tar_data}
 
 
 def _add_inputs_outputs_in_message(message, inputs, outputs):
@@ -286,7 +300,7 @@ def create_step(
         outputs,
         step_name=step_name,
     )
-    files = _prepare_create_step_files(container_config, data, function_path)
+    files = _prepare_create_step_files(sdk, container_config, data, function_path)
 
     log_action(
         sdk,
@@ -403,15 +417,6 @@ def list_steps(sdk: BaseCraftAiSdk):
         * ``"step_name"`` (:obj:`str`): Name of the step.
         * ``"status"`` (:obj:`str`): either ``"creation_pending"`` or ``"ready"``.
         * ``"created_at"`` (:obj:`str`): The creation date in ISO format.
-        * ``"updated_at"`` (:obj:`str`): The last update date in ISO format.
-        * ``"repository_branch"`` (:obj:`str`): The branch of the
-          repository where the step was built.
-        * ``"repository_url"`` (:obj:`str`): The url of the repository
-          where the step was built.
-        * ``"commit_id"`` (:obj:`str`): The commit id on which the step was
-          built.
-        * ``"origin"`` (:obj:`str`): The origin of the step, can be
-          ``"git_repository"`` or ``"local"``.
     """
     url = f"{sdk.base_environment_api_url}/steps"
 
@@ -474,3 +479,47 @@ def download_step_local_folder(sdk: BaseCraftAiSdk, step_name, folder):
             f.write(object_content)
     else:
         raise ValueError("'folder' must be a string")
+
+
+@log_func_result("Step logs")
+def get_step_logs(
+    sdk: BaseCraftAiSdk,
+    step_name,
+    from_datetime=None,
+    to_datetime=None,
+    limit=None,
+):
+    """Get the logs of a step.
+
+    Args:
+        step_name (:obj:`str`): Name of the step.
+        from_datetime (:obj:`datetime.time`, optional): Datetime from which the logs
+            are collected.
+        to_datetime (:obj:`datetime.time`, optional): Datetime until which the logs
+            are collected.
+        limit (:obj:`int`, optional): Maximum number of logs that are collected.
+
+    Returns:
+        :obj:`list` of :obj:`dict`: List of collected logs represented as dict with
+        the following keys:
+
+        * ``"timestamp"`` (:obj:`str`): Timestamp of the log.
+        * ``"message"`` (:obj:`str`): Log message.
+    """
+    url = f"{sdk.base_environment_api_url}/steps/{step_name}/logs"
+
+    data = {}
+    if from_datetime is not None:
+        data["from"] = _datetime_to_timestamp_in_ms(from_datetime)
+    if to_datetime is not None:
+        data["to"] = _datetime_to_timestamp_in_ms(to_datetime)
+    if limit is not None:
+        data["limit"] = limit
+
+    log_action(
+        sdk,
+        "Please wait while logs are being fetched. This may take a while...",
+    )
+    logs = sdk._post(url, json=data)
+
+    return logs

{craft_ai_sdk-0.50.1rc2 → craft_ai_sdk-0.51.0rc1}/craft_ai_sdk/sdk.py

@@ -59,6 +59,7 @@ class CraftAiSdk(BaseCraftAiSdk):
         list_steps,
         delete_step,
         download_step_local_folder,
+        get_step_logs,
     )
     from .core.pipelines import (
         create_pipeline,
@@ -66,6 +67,7 @@ class CraftAiSdk(BaseCraftAiSdk):
         list_pipelines,
         delete_pipeline,
         download_pipeline_local_folder,
+        get_pipeline_logs,
     )
     from .core.pipeline_executions import (
         run_pipeline,
@@ -128,7 +130,7 @@ class CraftAiSdk(BaseCraftAiSdk):
         os.environ.get("CRAFT_AI__MULTIPART_PART_SIZE__B", str(38 * 256 * 1024))
     )
     _access_token_margin = timedelta(seconds=30)
-    _version = "0.50.1rc2"  # Would be better to share it somewhere
+    _version = "0.51.0rc1"  # Would be better to share it somewhere
 
     def __init__(
         self,

{craft_ai_sdk-0.50.1rc2 → craft_ai_sdk-0.51.0rc1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "craft-ai-sdk"
-version = "0.50.1rc2"
+version = "0.51.0rc1"
 description = "Craft AI MLOps platform SDK"
 license = "Apache-2.0"
 authors = ["Craft AI <contact@craft.ai>"]

{craft_ai_sdk-0.50.1rc2 → craft_ai_sdk-0.51.0rc1}/setup.py

@@ -24,7 +24,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'craft-ai-sdk',
-    'version': '0.50.1rc2',
+    'version': '0.51.0rc1',
     'description': 'Craft AI MLOps platform SDK',
     'long_description': '# Craft AI Python SDK\n\nThis Python SDK lets you interact with Craft AI MLOps Platform.\n\n## Installation\nThis project relies on **Python 3.8+**. Once a supported version of Python is installed, you can install `craft-ai-sdk` from PyPI with:\n\n```console\npip install craft-ai-sdk\n```\n\n## Basic usage\nYou can configure the SDK by instantiating the `CraftAiSdk` class in this way:\n\n```python\nfrom craft_ai_sdk import CraftAiSdk\n\nCRAFT_AI_SDK_TOKEN =  # your access key obtained from your settings page\nCRAFT_AI_ENVIRONMENT_URL =  # url to your environment\n\nsdk = CraftAiSdk(sdk_token=CRAFT_AI_SDK_TOKEN, environment_url=CRAFT_AI_ENVIRONMENT_URL)\n```\n\nIf using the SDK in interactive mode, some additional feedbacks will be printed. You can force disable or enable those logs by either\n* Setting the `verbose_log` SDK parameter\n* Or setting the `SDK_VERBOSE_LOG` env var\n',
     'author': 'Craft AI',