cgcsdk 1.2.5__tar.gz → 1.3.0__tar.gz

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

@@ -1,76 +1,76 @@
-Metadata-Version: 2.4
-Name: cgcsdk
-Version: 1.2.5
-Summary: CGC Core REST API client
-Home-page: https://cgc.comtegra.cloud/
-Author: Comtegra AI Team
-Author-email: ai@comtegra.pl
-License: BSD 2-clause
-Project-URL: Documentation, https://docs.cgc.comtegra.cloud/
-Project-URL: GitHub, https://git.comtegra.pl/k8s/cgc-client-k8s-cloud
-Project-URL: Changelog, https://git.comtegra.pl/k8s/cgc-client-k8s-cloud/-/blob/main/cgc/CHANGELOG.md
-Keywords: cloud,sdk,orchestrator,kubernetes,jupyter-notebook,cgc-core
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: click
-Requires-Dist: python-dotenv
-Requires-Dist: tabulate
-Requires-Dist: pycryptodomex
-Requires-Dist: paramiko>=2.11
-Requires-Dist: statsd
-Requires-Dist: requests
-Requires-Dist: setuptools
-Requires-Dist: colorama
-Requires-Dist: psycopg2-binary
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: license-file
-Dynamic: project-url
-Dynamic: requires-dist
-Dynamic: summary
-
-# Comtegra GPU Cloud CLI Client
-
-## Basic info
-
-CGC Clinet is complete solution to create and manage your compute resources through CLI interface and python code. It incorporates CLI and SDK in one package.
-
-CGC CLI is a command line interface for Comtegra GPU Cloud. CGC CLI enables management of your Comtegra GPU Cloud resources. Current version of the app provides support for compute, storage and network resurces to be created, listed and deleted. Every compute resource is given to you as an URL, which is accessible from open Internet.
-
-To enable better access to your storage resources, every account has the ability to spawn free of charge filebrowser which is local implementation of dropbox. Remember to mount newely created volumes to it.
-
-For now, we provide the ability to spawn compute resources like:
-
-1. [Jupyter notebook](https://jupyter.org/) with tensorflow or pytorch installed as default
-2. [Triton inferencing server](https://docs.nvidia.com/deeplearning/triton-inference-server/) for large scale inferencing
-3. [Label studio](https://labelstud.io/) for easy management of your data annotation tasks with variety of modes
-4. [Rapids](https://rapids.ai/) suite of accelerated libraries for data processing
-
-Notebooks are equiped with all CUDA libraries and GPU drivers which enables the usage of GPU for accelerated computations.
-Apart from compute resources, we provide the database engines accessible from within your namespace:
-
-1. [PostgreSQL](https://www.postgresql.org/)
-2. [Weaviate](https://weaviate.io/)
-
-More are coming!
-Please follow instructions to get started.
-
-## More info
-
-If you'd like to know more visit:
-
-- [Comtegra GPU Website](https://cgc.comtegra.cloud)
-- [Docs](https://docs.cgc.comtegra.cloud)
+Metadata-Version: 2.4
+Name: cgcsdk
+Version: 1.3.0
+Summary: CGC Core REST API client
+Home-page: https://cgc.comtegra.cloud/
+Author: Comtegra AI Team
+Author-email: ai@comtegra.pl
+License: BSD 2-clause
+Project-URL: Documentation, https://docs.cgc.comtegra.cloud/
+Project-URL: GitHub, https://git.comtegra.pl/k8s/cgc-client-k8s-cloud
+Project-URL: Changelog, https://git.comtegra.pl/k8s/cgc-client-k8s-cloud/-/blob/main/cgc/CHANGELOG.md
+Keywords: cloud,sdk,orchestrator,kubernetes,jupyter-notebook,cgc-core
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: python-dotenv
+Requires-Dist: tabulate
+Requires-Dist: pycryptodomex
+Requires-Dist: paramiko>=2.11
+Requires-Dist: statsd
+Requires-Dist: requests
+Requires-Dist: setuptools
+Requires-Dist: colorama
+Requires-Dist: psycopg2-binary
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: summary
+
+# Comtegra GPU Cloud CLI Client
+
+## Basic info
+
+CGC Clinet is complete solution to create and manage your compute resources through CLI interface and python code. It incorporates CLI and SDK in one package.
+
+CGC CLI is a command line interface for Comtegra GPU Cloud. CGC CLI enables management of your Comtegra GPU Cloud resources. Current version of the app provides support for compute, storage and network resurces to be created, listed and deleted. Every compute resource is given to you as an URL, which is accessible from open Internet.
+
+To enable better access to your storage resources, every account has the ability to spawn free of charge filebrowser which is local implementation of dropbox. Remember to mount newely created volumes to it.
+
+For now, we provide the ability to spawn compute resources like:
+
+1. [Jupyter notebook](https://jupyter.org/) with tensorflow or pytorch installed as default
+2. [Triton inferencing server](https://docs.nvidia.com/deeplearning/triton-inference-server/) for large scale inferencing
+3. [Label studio](https://labelstud.io/) for easy management of your data annotation tasks with variety of modes
+4. [Rapids](https://rapids.ai/) suite of accelerated libraries for data processing
+
+Notebooks are equiped with all CUDA libraries and GPU drivers which enables the usage of GPU for accelerated computations.
+Apart from compute resources, we provide the database engines accessible from within your namespace:
+
+1. [PostgreSQL](https://www.postgresql.org/)
+2. [Weaviate](https://weaviate.io/)
+
+More are coming!
+Please follow instructions to get started.
+
+## More info
+
+If you'd like to know more visit:
+
+- [Comtegra GPU Website](https://cgc.comtegra.cloud)
+- [Docs](https://docs.cgc.comtegra.cloud)

{cgcsdk-1.2.5 → 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 = 5
+MAJOR_VERSION = 3
+MINOR_VERSION = 0

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

@@ -1,5 +1,25 @@
 # 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
+
+* `cgc resource scale up` scales up the resource replicas, with the given name
+* `cgc resource scale down` scales down the resource replicas, with the given name
+* modified error message displayed - uses custom_exceptions
+* listing of `TurnedOff` resources is now available
+* `TurnedOn` available if the resource is not running, but it is scaled up
+
 ## 1.2.5
 
 Release on Apr 16, 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.5 → cgcsdk-1.3.0}/cgc/commands/compute/compute_responses.py

@@ -62,6 +62,10 @@ def compute_list_response(detailed: bool, data: dict) -> str:
     pod_list = data["details"]["pods_list"]
     setup_gauge(f"{get_namespace()}.compute.count", len(pod_list))
 
+    # disabled resources pod list
+    other_pods_list = data["details"].get("other_pods_list", [])
+    pod_list.extend(other_pods_list)
+
     if not pod_list:
         raise NoAppsToList()
 
@@ -156,6 +160,20 @@ def compute_delete_response(data: dict) -> str:
     return f"App {name} and its service successfully deleted."
 
 
+@key_error_decorator_for_helpers
+def compute_scale_response(data: dict) -> str:
+    """Create response string for compute scale command.
+
+    :param response: dict object from API response.
+    :type response: requests.Response
+    :return: Response string.
+    :rtype: str
+    """
+    name = data["details"]["template_name"]
+    replicas = data["details"]["replicas"]
+    return f"App {name} has been successfully scaled to {replicas} replicas."
+
+
 @key_error_decorator_for_helpers
 def compute_restart_response(data: dict) -> str:
     """Create response string for compute restart command.

{cgcsdk-1.2.5 → cgcsdk-1.3.0}/cgc/commands/compute/compute_utils.py

@@ -83,6 +83,13 @@ def get_app_list(pod_list: list, detailed: bool) -> list:
     """
     output_data = []
 
+    def update_output_data_count(pod_name):
+        for pod in output_data:
+            if pod["name"] == pod_name:
+                pod["count"] += 1
+                return True
+        return False
+
     for pod in pod_list:
         try:
             main_container_name = pod["labels"]["entity"]
@@ -94,7 +101,7 @@ def get_app_list(pod_list: list, detailed: bool) -> list:
                 raise Exception(
                     "Parser was unable to find main container in server output in container list"
                 )
-            volumes_mounted = list_get_mounted_volumes(main_container["mounts"])
+            volumes_mounted = list_get_mounted_volumes(main_container.get("mounts", []))
             limits = main_container["resources"].get("limits")
             cpu = limits.get("cpu") if limits is not None else 0
             ram = limits.get("memory") if limits is not None else "0Gi"
@@ -106,6 +113,7 @@ def get_app_list(pod_list: list, detailed: bool) -> list:
                 "volumes_mounted": volumes_mounted,
                 "cpu": cpu,
                 "ram": ram,
+                "count": pod.get("replicas", 1), # first in the list are always pods
             }
             # getting rid of unwanted and used values
             if "pod-template-hash" in pod["labels"].keys():
@@ -139,7 +147,9 @@ def get_app_list(pod_list: list, detailed: bool) -> list:
 
             # appending the rest of labels
             pod_data.update(pod["labels"])
-            output_data.append(pod_data)
+
+            if not update_output_data_count(pod_data["name"]):
+                output_data.append(pod_data)
         except KeyError:
             pass