cgcsdk 1.2.6__tar.gz → 1.3.0__tar.gz

{cgcsdk-1.2.6/cgcsdk.egg-info → cgcsdk-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cgcsdk
-Version: 1.2.6
+Version: 1.3.0
 Summary: CGC Core REST API client
 Home-page: https://cgc.comtegra.cloud/
 Author: Comtegra AI Team

{cgcsdk-1.2.6 → cgcsdk-1.3.0}/cgc/.env

@@ -5,5 +5,5 @@ API_SECURE_CONNECTION=yes
 CONFIG_FILE_NAME = cfg.json
 TMP_DIR = .tmp
 RELEASE = 1
-MAJOR_VERSION = 2
-MINOR_VERSION = 6
+MAJOR_VERSION = 3
+MINOR_VERSION = 0

{cgcsdk-1.2.6 → cgcsdk-1.3.0}/cgc/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## 1.3.0
+
+Release on July 08, 2025
+
+* stop events are not longer supported
+* billing endpoints v1 are not longer supported
+* added support for v2 billing endpoints
+* added `cgc billing pricing` command
+* error messages are now more descriptive
+
 ## 1.2.6
 
 Release on Apr 30, 2025

cgcsdk-1.3.0/cgc/commands/compute/billing/billing_cmd.py

@@ -0,0 +1,118 @@
+import click
+
+from datetime import datetime
+
+from cgc.commands.compute.billing.billing_responses import (
+    billing_pricing_response,
+    billing_status_response,
+    billing_invoice_response,
+)
+from cgc.utils.prepare_headers import get_api_url_and_prepare_headers
+from cgc.utils.response_utils import retrieve_and_validate_response_send_metric
+from cgc.utils.click_group import CustomGroup, CustomCommand
+from cgc.utils.requests_helper import call_api, EndpointTypes
+
+
+@click.group("billing", cls=CustomGroup)
+def billing_group():
+    """
+    Access and manage billing information.
+    """
+    pass
+
+
+@billing_group.command("status", cls=CustomCommand)
+@click.option(
+    "--detailed",
+    "-d",
+    "detailed",
+    prompt=True,
+    type=bool,
+    default=False,
+    help="If true, returns detailed invoice information",
+    is_flag=True,
+)
+def billing_status(detailed: bool):
+    """
+    Shows billing status for user namespace
+    """
+    api_url, headers = get_api_url_and_prepare_headers()
+    url = f"{api_url}/v2/api/billing/status?details={detailed}"
+    metric = "billing.status"
+    __res = call_api(request=EndpointTypes.get, url=url, headers=headers)
+    click.echo(
+        billing_status_response(
+            retrieve_and_validate_response_send_metric(__res, metric)
+        )
+    )
+
+
+def _get_previous_month():
+    return datetime.now().month - 1 if datetime.now().month > 1 else 12
+
+
+def _get_previous_year_if_required():
+    return datetime.now().year - 1 if datetime.now().month == 1 else datetime.now().year
+
+
+@billing_group.command("invoice", cls=CustomCommand)
+@click.option(
+    "--year",
+    "-y",
+    "year",
+    prompt=True,
+    type=int,
+    default=_get_previous_year_if_required(),
+)
+@click.option(
+    "--month",
+    "-m",
+    "month",
+    prompt=True,
+    type=click.IntRange(1, 12),
+    default=_get_previous_month(),
+)
+@click.option(
+    "--detailed",
+    "-d",
+    "detailed",
+    prompt=True,
+    type=bool,
+    default=False,
+    help="If true, returns detailed invoice information",
+    is_flag=True,
+)
+def billing_invoice(year: int, month: int, detailed: bool):
+    """
+    Opens invoice from given year and month
+    """
+    api_url, headers = get_api_url_and_prepare_headers()
+    url = (
+        f"{api_url}/v2/api/billing/invoice?year={year}&month={month}&details={detailed}"
+    )
+    metric = "billing.invoice"
+    __res = call_api(request=EndpointTypes.get, url=url, headers=headers)
+
+    click.echo(
+        billing_invoice_response(
+            year,
+            month,
+            retrieve_and_validate_response_send_metric(__res, metric),
+        )
+    )
+
+
+@billing_group.command("pricing", cls=CustomCommand)
+def billing_pricing():
+    """
+    Shows billing pricing information for user
+    """
+    api_url, headers = get_api_url_and_prepare_headers()
+    url = f"{api_url}/v2/api/billing/user_pricing"
+    metric = "billing.pricing"
+    __res = call_api(request=EndpointTypes.get, url=url, headers=headers)
+    click.echo(
+        billing_pricing_response(
+            retrieve_and_validate_response_send_metric(__res, metric)
+        )
+    )

cgcsdk-1.3.0/cgc/commands/compute/billing/billing_responses.py

@@ -0,0 +1,65 @@
+import calendar
+import click
+from decimal import Decimal
+from tabulate import tabulate
+from cgc.commands.compute.billing import (
+    NoCostsFound,
+    NoInvoiceFoundForSelectedMonth,
+)
+from cgc.commands.compute.billing.billing_utils import get_billing_status_message
+from cgc.utils.message_utils import key_error_decorator_for_helpers
+
+
+@key_error_decorator_for_helpers
+def billing_status_response(data: dict) -> str:
+    total_cost = data["details"]["cost_total"]
+    namespace = data["details"]["namespace"]
+    billing_records = data["details"]["billing_records"]
+    details = data["details"].get("details", [])
+    if not billing_records:
+        raise NoCostsFound()
+    message = get_billing_status_message(billing_records, details)
+    message += f"Total cost for namespace {namespace}: {total_cost:.2f} pln"
+    return message
+
+
+@key_error_decorator_for_helpers
+def billing_invoice_response(year: int, month: int, data: dict) -> str:
+    total_cost = float(data["details"]["cost_total"])
+    namespace = data["details"]["namespace"]
+    billing_records = data["details"]["billing_records"]
+    details = data["details"].get("details", [])
+    if (
+        not billing_records or total_cost == 0
+    ):  # TODO: total_cost == 0 is it correct thinking?
+        raise NoInvoiceFoundForSelectedMonth(year, month)
+    message = get_billing_status_message(billing_records, details)
+    message += f"Total cost for namespace {namespace} in {calendar.month_name[month]} {year}: {total_cost:.2f} pln"
+    return message
+
+
+@key_error_decorator_for_helpers
+def billing_pricing_response(data: dict) -> str:
+    """Create response string for billing pricing command.
+
+    :return: Response string.
+    :rtype: str
+    """
+    pricing_details = data["details"]["pricing_details"]
+    if not pricing_details:
+        return "No pricing details available."
+    if pricing_details.get("tier"):
+        tier = pricing_details["tier"] or "DEFAULT"
+        click.echo(f"Current pricing tier: {tier}")
+    if not pricing_details.get("resources"):
+        return "No resources costs available."
+    headers = ["Resource", "Price per unit (pln) / (second OR token)"]
+    pricing_data = [
+        (resource, f"{Decimal(str(price)):.7f}")
+        for resource, price in pricing_details.get("resources").items()
+    ]
+    click.echo(
+        "Pricing values displayed are approximated due to float representation. For exact values, refer to the billing system dashboard."
+    )
+
+    return tabulate(pricing_data, headers=headers)

cgcsdk-1.3.0/cgc/commands/compute/billing/billing_utils.py

@@ -0,0 +1,241 @@
+import click
+import datetime
+import sys
+from tabulate import tabulate
+from cgc.utils.message_utils import (
+    prepare_error_message,
+)
+
+
+def verify_input_datetime(*args):
+    try:
+        for arg in args:
+            datetime.datetime.strptime(arg, "%d-%m-%Y")
+    except ValueError:
+        click.echo(prepare_error_message("Incorrect date format, should be DD-MM-YYYY"))
+        sys.exit()
+
+
+def _get_costs_list_for_user(costs_list: list):
+    """Format data in costs list to be displayed in a table and calculate user cost
+
+    :param costs_list: list of costs for user
+    :type costs_list: list
+    :return: formatted list of costs and total cost for user
+    :rtype: user_costs_list_to_print: list, total_user_cost: float
+    """
+    user_costs_list_to_print = []
+    total_user_cost = 0
+
+    for cost in costs_list:
+        if "resource_cost" in cost:
+            if cost.get("type", "") == "oneoff":
+                for resource, value in cost["resource_cost"].items():
+                    user_costs_list_to_print.append(
+                        [
+                            cost.get("type", ""),
+                            cost.get("namespace", ""),
+                            f"{resource}: {float(value):.2f} pln",
+                            "-",
+                            "-",
+                            "<<-",
+                        ]
+                    )
+                    total_user_cost += float(cost.get("cost_total", 0))
+            else:
+                resource_cost_str = ", ".join(
+                    f"{k}: {float(v):.2f}" for k, v in cost["resource_cost"].items()
+                )
+                start, end = "-", "-"
+                if "datetime_range" in cost and len(cost["datetime_range"]) == 2:
+                    start, end = cost["datetime_range"]
+                user_costs_list_to_print.append(
+                    [
+                        cost.get("type", ""),
+                        cost.get("namespace", ""),
+                        resource_cost_str,
+                        start,
+                        end,
+                        f"{float(cost.get('cost_total', 0)):.2f} pln",
+                    ]
+                )
+                total_user_cost += float(cost.get("cost_total", 0))
+
+    if costs_list:
+        user_costs_list_to_print.sort(key=lambda d: f"{d[0]} {d[1]}")
+    return user_costs_list_to_print, total_user_cost
+
+
+def _get_costs_list_for_user_with_details(costs_list: list):
+    """Format data in costs list to be displayed in a table and calculate user cost with details
+
+    :param costs_list: list of costs for user
+    :type costs_list: list
+    :return: formatted list of costs and total cost for user
+    :rtype: user_costs_list_to_print: list, total_user_cost: float
+    """
+    user_costs_list_to_print = []
+    total_user_cost = 0
+
+    for cost in costs_list:
+        # Support both old and new structure
+        record = cost.get("record", {})
+        name = record.get("name", cost.get("name", ""))
+        # id_ = record.get("id", cost.get("id", ""))
+        user_id = record.get("user_id", cost.get("user_id", ""))
+        namespace = record.get("namespace", cost.get("namespace", ""))
+        type_ = record.get("type", cost.get("type", ""))
+        resource_cost = cost.get("resource_cost", {})
+        if type_ == "oneoff":
+            for resource, value in resource_cost.items():
+                user_costs_list_to_print.append(
+                    [
+                        name,
+                        user_id,
+                        namespace,
+                        type_,
+                        f"{resource}: {float(value):.2f} pln",
+                        "-",
+                        "-",
+                        "<<-",
+                    ]
+                )
+                total_user_cost += float(cost.get("cost_total", 0))
+        else:
+            resource_cost_str = ", ".join(
+                f"{k}: {float(v):.2f}" for k, v in resource_cost.items()
+            )
+            start = cost.get("calculation_start_time", "-")
+            end = cost.get("calculation_end_time", "-")
+            cost_total = cost.get("cost_total", 0)
+
+            user_costs_list_to_print.append(
+                [
+                    name,
+                    # id_,
+                    user_id,
+                    namespace,
+                    type_,
+                    resource_cost_str,
+                    start,
+                    end,
+                    f"{float(cost_total):.2f} pln",
+                ]
+            )
+        total_user_cost += float(cost_total)
+
+    if costs_list:
+        user_costs_list_to_print.sort(key=lambda d: f"{d[0]} {d[1]}")
+    return user_costs_list_to_print, total_user_cost
+
+
+def get_billing_status_message(billing_records: list, details: list = []):
+    """Prints billing status for all users in a pretty table
+
+    :param user_list: list of users with costs
+    :type user_list: list
+    """
+    message = ""
+    users = set(
+        record.get("user_id", "") for record in billing_records
+    )  # Get unique user IDs
+    if not users:
+        return "No billing records found."
+    for user in users:
+        user_records = [
+            record for record in billing_records if record["user_id"] == user
+        ]
+        costs_list_to_print, _user_cost = _get_costs_list_for_user(user_records)
+        list_headers = _get_status_list_headers()
+        message += f"Billing status for user: {user}\n"
+        message += tabulate(costs_list_to_print, headers=list_headers)
+        message += f"\n\nSummary user cost: {float(_user_cost):.2f} pln\n\n"
+    if details:
+        message += "Detailed billing records:\n"
+        costs_list_to_print, _ = _get_costs_list_for_user_with_details(details)
+        if not costs_list_to_print:
+            message += "No detailed billing records found.\n"
+        else:
+            list_headers = _get_billing_details_list_headers()
+            message += tabulate(costs_list_to_print, headers=list_headers)
+            message += "\n\n"
+    return message
+
+
+def _get_status_list_headers():
+    """Generates headers for billing status command
+
+    :return: list of headers
+    :rtype: list
+    """
+    return ["type", "namespace", "resource breakdown", "start", "end", "cost"]
+
+
+def _get_billing_details_list_headers():
+    """Generates headers for billing details command
+
+    :return: list of headers
+    :rtype: list
+    """
+    return [
+        "name",
+        # "id",
+        "user_id",
+        "namespace",
+        "type",
+        "resource breakdown",
+        "start",
+        "end",
+        "cost_total",
+    ]
+
+
+# TODO: refactor to use: tabulate_a_response(data: list) -> str:
+def get_table_compute_stop_events_message(event_list: list):
+    """Prints compute stop events info
+
+    :param event_list: raw list of events
+    :type event_list: list
+    """
+    message = "Compute stop events:"
+    event_list_headers = ["id", "name", "entity", "date created"]
+    event_list_to_print = []
+    for event in event_list:
+        event_id = event["event_id"]
+        event_name = event["event_name"]
+        event_date = event["date_created"]
+        event_entity = event["entity"]
+        row_list = [event_id, event_name, event_entity, event_date]
+        event_list_to_print.append(row_list)
+    message += tabulate(event_list_to_print, headers=event_list_headers)
+    return message
+
+
+# TODO: refactor to use: tabulate_a_response(data: list) -> str:
+def get_table_volume_stop_events_message(event_list: list):
+    """Prints volume stop events info
+
+    :param event_list: raw list of events
+    :type event_list: list
+    """
+    message = "Volume stop events:"
+    event_list_headers = [
+        "id",
+        "name",
+        "disks type",
+        "access type",
+        "size",
+        "date created",
+    ]
+    event_list_to_print = []
+    for event in event_list:
+        event_id = event["event_id"]
+        volume_name = event["volume_name"]
+        event_date = event["date_created"]
+        disks_type = event["disks_type"]
+        access_type = event["access_type"]
+        size = event["size"]
+        row_list = [event_id, volume_name, disks_type, access_type, size, event_date]
+        event_list_to_print.append(row_list)
+    message += tabulate(event_list_to_print, headers=event_list_headers)
+    return message

{cgcsdk-1.2.6 → cgcsdk-1.3.0}/cgc/commands/volume/volume_responses.py

@@ -41,7 +41,7 @@ def volume_storage_class_details_response(data: dict) -> str:
     :rtype: str
     """
     # ["details"]["storage_class"] -> storage class name
-    # ["details"]["storage_class_info"] -> billing_cost, storage_type, reclaim_policy, volume_binding_mode
+    # ["details"]["storage_class_info"] -> storage_type, reclaim_policy, volume_binding_mode
 
     storage_class_headers = [
         "name",

{cgcsdk-1.2.6 → cgcsdk-1.3.0}/cgc/utils/custom_exceptions.py

@@ -3,33 +3,33 @@
 # every warning has its message that will be returned to print
 CUSTOM_EXCEPTIONS = {
     500: {
-        "UNDEFINED": "undefined exception",
-        "USER_KEY_CREATE_ERROR": "Error while creating key",
-        "RESOURCE_SCALE_TEMPLATE_ERROR": "Error while scaling resource - resource not fully compatible CGC",
+        "UNDEFINED": "Undefined exception.",
+        "USER_KEY_CREATE_ERROR": "Error while creating key.",
+        "RESOURCE_SCALE_TEMPLATE_ERROR": "Error while scaling resource - resource not fully compatible with CGC.",
     },
     413: {
-        "PVC_CREATE_STORAGE_LIMIT_EXCEEDED": "This request exceeds your storage limits",
-        "PVC_CREATE_NOT_ENOUGH_STORAGE_IN_CLUSTER": "No more storage available",
-        "REQUEST_RESOURCE_LIMIT_EXCEEDED": "This request exceeds your resources limit",
-        "RESOURCES_NOT_AVAILABLE_IN_CLUSTER": "Requested resources not available",
-        "RESOURCE_SCALE_RESOURCES_LIMIT_EXCEEDED": "This request exceeds your resources limit",
-        "PVC_CREATE_STORAGE_LIMIT_EXCEEDED": "Storage limit exceeded",
+        "PVC_CREATE_STORAGE_LIMIT_EXCEEDED": "This request exceeds your storage limits.",
+        "PVC_CREATE_NOT_ENOUGH_STORAGE_IN_CLUSTER": "No more storage available.",
+        "REQUEST_RESOURCE_LIMIT_EXCEEDED": "This request exceeds your resource limits.",
+        "RESOURCES_NOT_AVAILABLE_IN_CLUSTER": "Requested resources are not available.",
+        "RESOURCE_SCALE_RESOURCES_LIMIT_EXCEEDED": "This request exceeds your resource limits.",
+        "PVC_CREATE_STORAGE_LIMIT_EXCEEDED": "Storage limit exceeded.",
     },
     409: {
-        "PVC_NAME_ALREADY_EXISTS": "Volume with this name already exists.",
-        "PVC_DELETE_EXCEPTION": "Can't delete mounted volume, try with force",
-        "RESOURCE_PORTS_ALREADY_EXISTS": "Port with this name already exists.",
-        "RESOURCE_TEMPLATE_NAME_ALREADY_EXISTS": "Resource with this name already exists.",
-        "JOB_CREATE_ALREADY_EXISTS": "Job with this name already exists.",
-        "USER_KEY_ALREADY_EXISTS": "Key with these data already exists.",
-        "AlreadyExists": "Object with this name already exists",
+        "PVC_NAME_ALREADY_EXISTS": "A volume with this name already exists.",
+        "PVC_DELETE_EXCEPTION": "Can't delete mounted volume. Try with force.",
+        "RESOURCE_PORTS_ALREADY_EXISTS": "A port with this name already exists.",
+        "RESOURCE_TEMPLATE_NAME_ALREADY_EXISTS": "A resource with this name already exists.",
+        "JOB_CREATE_ALREADY_EXISTS": "A job with this name already exists.",
+        "USER_KEY_ALREADY_EXISTS": "A key with this data already exists.",
+        "AlreadyExists": "An object with this name already exists.",
     },
     404: {
-        "PVC_CREATE_NO_SC": "Selected disk type and access mode unavailable",
+        "PVC_CREATE_NO_SC": "Selected disk type and access mode are unavailable.",
         "BILLING_STATUS_NO_DATA": "No data to print.",
         "NOT_DELETED_ANYTHING_IN_COMPUTE_DELETE": "No app with this name to delete.",
-        "API_KEY_DELETE_ERROR": "No api key with this id to delete",
-        "PVC_MOUNT_NOT_FOUND_TEMPLATE": "No volume with this name to mount.",
+        "API_KEY_DELETE_ERROR": "No API key with this ID to delete.",
+        "PVC_MOUNT_NOT_FOUND_TEMPLATE": "App resource with this name not found.",
         "PVC_UNMOUNT_NOT_MOUNTED": "Volume with this name is not mounted.",
         "PVC_NOT_FOUND": "Volume with this name not found.",
         "PVC_DELETE_NOT_FOUND": "App with this name not found.",
@@ -39,21 +39,21 @@ CUSTOM_EXCEPTIONS = {
         "COMPUTE_RESOURCE_QUOTA_NOT_FOUND": "You do not have enforced limits on your namespace.",
         "JOB_NOT_FOUND": "Job with this name not found.",
         "RESOURCE_NOT_FOUND": "Resource with this name not found.",
-        "USER_KEY_NOT_FOUND": "Key with this id not found.",
+        "USER_KEY_NOT_FOUND": "Key with this ID not found.",
         "RESOURCE_SCALE_TEMPLATE_NOT_FOUND": "No app with this name.",
-        "NotFound": "Resource not found",
+        "NotFound": "Resource not found.",
         "USER_SECRET_UPDATE_NOT_FOUND": "Secret not found.",
         "USER_SECRET_DELETE_NOT_FOUND": "Secret not found.",
         "PVC_SC_NOT_FOUND": "Storage class with this name is not defined.",
-        "RESOURCE_RESTART_TEMPLATE_NOT_FOUND": "Resource with this name not found",
-        "NOT_DELETED_ANYTHING_IN_RESOURCE_DELETE": "There is nothing to delete with this name",
+        "RESOURCE_RESTART_TEMPLATE_NOT_FOUND": "Resource with this name not found.",
+        "NOT_DELETED_ANYTHING_IN_RESOURCE_DELETE": "There is nothing to delete with this name.",
     },
     400: {
         "WRONG_DATE_FORMAT": "Wrong date format.",
         "ENTITY_NOT_ALLOWED": "You can't create this entity.",
         "PVC_MOUNT_ALREADY_MOUNTED": "This volume is already mounted.",
-        "TEMPLATE_NAME_SYSTEM_RESERVED": "You can't create app with this name.",
-        "JOB_LACKS_REQUIRED_PARAMETER": "Job requires container image parameter.",
-        "RESOURCE_PORTS_EXCEPTION": "Resource with this name not found",
+        "TEMPLATE_NAME_SYSTEM_RESERVED": "You can't create an app with this name.",
+        "JOB_LACKS_REQUIRED_PARAMETER": "Job requires a container image parameter.",
+        "RESOURCE_PORTS_EXCEPTION": "Resource with this name not found.",
     },
 }

{cgcsdk-1.2.6 → cgcsdk-1.3.0}/cgc/utils/message_utils.py

@@ -63,5 +63,9 @@ def key_error_decorator_for_helpers(func):
             return prepare_error_message(UNKNOWN_ERROR)
         except (ResponseException, click.ClickException) as err:
             return prepare_warning_message(err)
+        except KeyboardInterrupt:
+            increment_metric(metric="client.interrupted", is_error=True)
+            # silently exit
+            exit(0)
 
     return wrapper

{cgcsdk-1.2.6 → cgcsdk-1.3.0}/cgc/utils/prepare_headers.py

@@ -20,7 +20,7 @@ def get_api_url_and_prepare_headers():
     }
     return get_headers_data.load_user_api_url(), headers
 
-
+@key_error_decorator_for_helpers
 def get_url_and_prepare_headers_register(
     user_id: str, access_key: str, url: str = None, secret: str = None
 ):
@@ -39,7 +39,7 @@ def get_url_and_prepare_headers_register(
     }
     return url, headers
 
-
+@key_error_decorator_for_helpers
 def get_url_and_headers_jwt_token():
     url = f"{get_headers_data.load_user_api_url()}/v1/api/user/create/token"
     headers = {
@@ -63,7 +63,7 @@ def prepare_headers_api_key(user_id: str = None, password: str = None):
     }
     return headers
 
-
+@key_error_decorator_for_helpers
 def get_api_url_and_prepare_headers_version_control():
     """Prepares headers for version control request.
 

{cgcsdk-1.2.6 → cgcsdk-1.3.0}/cgc/utils/requests_helper.py

@@ -59,6 +59,10 @@ def call_api(request: EndpointTypes, **kwargs):
     except OSError:
         increment_metric(metric="client.certificate", is_error=True)
         click.echo(prepare_error_message(CERTIFICATE_ERROR))
+    except KeyboardInterrupt:
+        increment_metric(metric="client.interrupted", is_error=True)
+        # silently exit
+        sys.exit()
     except:
         increment_metric(metric="client.unhandled", is_error=True)
         click.echo(prepare_error_message(UNKNOWN_ERROR))

{cgcsdk-1.2.6 → cgcsdk-1.3.0/cgcsdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cgcsdk
-Version: 1.2.6
+Version: 1.3.0
 Summary: CGC Core REST API client
 Home-page: https://cgc.comtegra.cloud/
 Author: Comtegra AI Team