c2client 0.24__tar.gz → 0.26__tar.gz

{c2client-0.24/c2client.egg-info → c2client-0.26}/PKG-INFO

@@ -1,14 +1,13 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: c2client
-Version: 0.24
-Summary: CROC Cloud Platform - API Client
+Version: 0.26
+Summary: RockitCloud Platform - API Client
 Home-page: https://github.com/c2devel/c2-client
-Author: CROC Cloud Team
-Author-email: devel@croc.ru
+Author: RockitCLoud Team
+Author-email: devel@k2.cloud
 Maintainer: Andrey Kulaev
 Maintainer-email: adkulaev@gmail.com
 License: GPL3
-Platform: UNKNOWN
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -22,11 +21,25 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-
-CROC Cloud API Client
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: boto3
+Requires-Dist: botocore
+Requires-Dist: inflection==0.3.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: maintainer
+Dynamic: maintainer-email
+Dynamic: requires-dist
+Dynamic: summary
+
+K2 Cloud API Client
 =====================
 
-Simple command-line utility for sending custom requests to CROC Cloud platform.
+Simple command-line utility for sending custom requests to K2 Cloud platform.
 
 **Warning: this utility is not intended for automation cases.
 Use https://github.com/c2devel/boto3.git and python scripts instead.**
@@ -34,11 +47,27 @@ Use https://github.com/c2devel/boto3.git and python scripts instead.**
 Installation
 ------------
 
-Using pip:
+C2client package relies on forked versions of boto3 and botocore from the `C2Devel/boto3 <https://github.com/c2Devel/boto3>`_ and `C2Devel/botocore <https://github.com/c2Devel/botocore>`_ repositories. For isolated use our dependencies, it is highly recommended to use a virtual environment.
+
+
+1. Clone the repository
+
+    .. code-block:: bash 
+
+       git clone https://github.com/C2Devel/c2-client.git && cd c2-client
+       
+2. Setup the virtual environment(Unix based system)
 
-   .. code-block:: bash
+    .. code-block:: bash 
+
+       python3 -m venv .venv && source .venv/bin/activate
+       
+3. Install the package in editable mode along with dependencies from requirements.txt
+
+    .. code-block:: bash
+
+       pip install -e . -r requirements.txt
 
-      $ pip install c2client
 
 Usage
 -----
@@ -74,5 +103,3 @@ Send simple request:
 
    $ c2-ec2 RunInstances ImageId cmi-078880A0 Description "Test instance" \
    InstanceType m1.small MaxCount 1 MinCount 1 SecurityGroup.1 test
-
-

{c2client-0.24 → c2client-0.26}/README.rst

@@ -1,7 +1,7 @@
-CROC Cloud API Client
+K2 Cloud API Client
 =====================
 
-Simple command-line utility for sending custom requests to CROC Cloud platform.
+Simple command-line utility for sending custom requests to K2 Cloud platform.
 
 **Warning: this utility is not intended for automation cases.
 Use https://github.com/c2devel/boto3.git and python scripts instead.**
@@ -9,11 +9,27 @@ Use https://github.com/c2devel/boto3.git and python scripts instead.**
 Installation
 ------------
 
-Using pip:
+C2client package relies on forked versions of boto3 and botocore from the `C2Devel/boto3 <https://github.com/c2Devel/boto3>`_ and `C2Devel/botocore <https://github.com/c2Devel/botocore>`_ repositories. For isolated use our dependencies, it is highly recommended to use a virtual environment.
 
-   .. code-block:: bash
 
-      $ pip install c2client
+1. Clone the repository
+
+    .. code-block:: bash 
+
+       git clone https://github.com/C2Devel/c2-client.git && cd c2-client
+       
+2. Setup the virtual environment(Unix based system)
+
+    .. code-block:: bash 
+
+       python3 -m venv .venv && source .venv/bin/activate
+       
+3. Install the package in editable mode along with dependencies from requirements.txt
+
+    .. code-block:: bash
+
+       pip install -e . -r requirements.txt
+
 
 Usage
 -----

c2client-0.26/c2client/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.26"

{c2client-0.24 → c2client-0.26}/c2client/clients.py

@@ -1,16 +1,18 @@
 import argparse
+import datetime
 import json
 import re
 import ssl
+import sys
 from abc import abstractmethod
 from functools import wraps
-from typing import Any, Dict, Optional
+from typing import Any, Callable, Dict, Optional
 
 import boto3
 import inflection
 
 from c2client.errors import InvalidMethodName
-from c2client.utils import from_dot_notation, get_env_var, convert_args
+from c2client.utils import convert_args, flatten_key_value_dict, from_dot_notation, get_env_var
 
 
 ssl._create_default_https_context = ssl._create_unverified_context
@@ -84,6 +86,12 @@ class BaseClient:
 
 class C2Client(BaseClient):
 
+    DOT_NOTATION_EXIT_HOOKS: Dict[str, Dict[str, Callable]] = {}
+    """
+    Per-method per-parameter transformation hooks
+    to be run after parsing request from dot notation.
+    """
+
     @classmethod
     def get_client(cls, verify: bool):
         """Return boto3 client."""
@@ -104,7 +112,13 @@ class C2Client(BaseClient):
         )
 
     @classmethod
-    def make_request(cls, method: str, arguments: Optional[Dict], verify: bool) -> str:
+    def make_request(
+        cls,
+        method: str,
+        arguments: Optional[Dict],
+        verify: bool,
+        convert_to_str: bool = True
+    ) -> str:
 
         client = cls.get_client(verify)
 
@@ -114,14 +128,22 @@ class C2Client(BaseClient):
         if arguments:
             arguments = cls.convert_fields_names(arguments)
             shape = client.meta.service_model.operation_model(method).input_shape
-            arguments = convert_args(from_dot_notation(arguments), shape)
+            arguments = convert_args(
+                from_dot_notation(
+                    arguments,
+                    exit_hooks=cls.DOT_NOTATION_EXIT_HOOKS.get(method),
+                ),
+                shape,
+            )
 
         result = getattr(client, inflection.underscore(method))(**arguments)
 
-        result.pop("ResponseMetadata", None)
+        if convert_to_str:
+            result.pop("ResponseMetadata", None)
 
-        # default=str is required for serializing Datetime objects
-        return json.dumps(result, indent=4, default=str)
+            # default=str is required for serializing Datetime objects
+            return json.dumps(result, indent=4, default=str)
+        return result
 
     @staticmethod
     def convert_fields_names(arguments: dict) -> Dict[str, Any]:
@@ -241,3 +263,76 @@ class DirectConnectClient(C2Client):
 
     url_key = "DIRECT_CONNECT_URL"
     client_name = "directconnect"
+
+
+class KMSClient(C2Client):
+
+    url_key = "KMS_URL"
+    client_name = "kms"
+
+
+class ResourceGroupsTaggingClient(C2Client):
+
+    url_key = "RGT_URL"
+    client_name = "resourcegroupstaggingapi"
+
+    DOT_NOTATION_EXIT_HOOKS = {
+        "TagResources": {
+            "Tags": flatten_key_value_dict,
+        }
+    }
+
+
+class LogsClient(C2Client):
+
+    url_key = "CLOUDWATCH_LOGS_URL"
+    client_name = "logs"
+
+    @classmethod
+    @exitcode
+    def execute(cls) -> None:
+        action, arguments, verify = parse_arguments()
+        if action == "StartLiveTail":
+            symbols = ["|", "/", "-", "\\"]
+            counter = 0
+
+            try:
+                resp = super().make_request(
+                    action, arguments, verify, convert_to_str=False
+                )
+                stream = resp["responseStream"]
+
+                skipped = False
+                got_logs = False
+
+                for item in stream:
+                    if not skipped and "sessionStart" in item:
+                        skipped = True
+                        continue
+
+                    if "sessionUpdate" in item:
+                        events = item["sessionUpdate"]["sessionResults"]
+                        if events:
+                            if not got_logs:
+                                got_logs = True
+                                print("\rLogs received:", " " * 8)
+
+                            for event in events:
+                                ts = datetime.datetime.fromtimestamp(
+                                    event.get("timestamp", 0) / 1_000
+                                )
+                                msg = event.get("message", "").strip()
+                                print(f"\r[{ts}] {msg}")
+
+                        sys.stdout.write(
+                            f"\rWaiting for logs... {symbols[counter % len(symbols)]}"
+                        )
+                        sys.stdout.flush()
+                        counter += 1
+                        sys.stdout.write("\r")
+
+            except KeyboardInterrupt:
+                print("\rReceiving events has been stopped.")
+        else:
+            response = cls.make_request(action, arguments, verify)
+            print(response)

{c2client-0.24 → c2client-0.26}/c2client/errors.py

@@ -20,3 +20,8 @@ class InvalidParameterName(Exception):
 class InvalidMethodName(Exception):
     def __init__(self, method_name: str) -> None:
         super().__init__(f"Not found method by name: {method_name}.")
+
+
+class InvalidListIndex(Exception):
+    def __init__(self, index: int) -> None:
+        super().__init__(f"The list's indices start at 1, and {index} is outside that range.")

{c2client-0.24 → c2client-0.26}/c2client/utils.py

@@ -1,10 +1,15 @@
 import dataclasses
 import os
-from typing import Any, Dict
+from typing import Any, Callable, Dict, List, Optional
 
 from botocore.model import ListShape, StructureShape, Shape
 
-from c2client.errors import EnvironmentVariableError, MalformedParametersError, InvalidParameterName
+from c2client.errors import (
+    EnvironmentVariableError,
+    MalformedParametersError,
+    InvalidParameterName,
+    InvalidListIndex,
+)
 
 
 @dataclasses.dataclass
@@ -15,8 +20,33 @@ class Parameter:
     shape: Shape
 
 
-def from_dot_notation(source):
-    """Convert a incoming query to a request dictionary.
+def flatten_key_value_dict(
+    target_list: List[Dict[str, Any]],
+    key_field: str = "Key",
+    value_field: str = "Value",
+ ) -> Dict[Any, Any]:
+    """
+    Generic flattening dot notation exit hook.
+
+    Transforms
+      [{<key_field>: <key>, <value_field>: <value>}]
+      into
+      {<key>: <value>}
+    """
+
+    return {
+        item[key_field]: item[value_field]
+        for item in target_list
+    }
+
+
+def from_dot_notation(
+    source: Dict[Any, Any],
+    exit_hooks: Optional[Dict[str, Callable]] = None,
+):
+    """
+    Convert a incoming query to a request dictionary.
+
     For example::
         1. {"Action": ["Action"], "Param": ["Value"]}
         2. {"Action": ["Action"], "Param.2": ["Value2"], "Param.1": ["Value1"]}
@@ -25,16 +55,23 @@ def from_dot_notation(source):
         1. {"Action": "Action", "Param": "Value"}
         2. {"Action": "Action", "Param": ["Value1", "Value2"]}
         3. {"Action": "Action", "Param": { "SubParam": "Value"}}
+
     :type query: dict
     :param query: This is dictionary, returned by '_get_query()'.
+    :type exit_hooks: dict
+    :param exit_hooks: Per-parameter mapping of additional transformation
+                       to be performed after parsing dot notation.
     """
 
     result = {"result": {}}
     for key, value in sorted(source.items()):
-        try:
-            _process_tokens(key.split("."), value, result, "result")
-        except Exception:
-            raise MalformedParametersError
+        _process_tokens(key.split("."), value, result, "result")
+
+    if exit_hooks is not None:
+        for parameter_name, exit_hook in exit_hooks.items():
+            if parameter_name in result["result"]:
+                result["result"][parameter_name] = exit_hook(result["result"][parameter_name])
+
     return result["result"]
 
 
@@ -42,6 +79,8 @@ def _process_tokens(tokens, value, parent, index):
     key, rest = tokens[0], tokens[1:]
     if key.isdigit():
         key = int(key) - 1
+        if key == -1:
+            raise InvalidListIndex(0)
 
     if not isinstance(key, int):
         parent[index].setdefault(key, {})

{c2client-0.24 → c2client-0.26/c2client.egg-info}/PKG-INFO

@@ -1,14 +1,13 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: c2client
-Version: 0.24
-Summary: CROC Cloud Platform - API Client
+Version: 0.26
+Summary: RockitCloud Platform - API Client
 Home-page: https://github.com/c2devel/c2-client
-Author: CROC Cloud Team
-Author-email: devel@croc.ru
+Author: RockitCLoud Team
+Author-email: devel@k2.cloud
 Maintainer: Andrey Kulaev
 Maintainer-email: adkulaev@gmail.com
 License: GPL3
-Platform: UNKNOWN
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -22,11 +21,25 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-
-CROC Cloud API Client
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: boto3
+Requires-Dist: botocore
+Requires-Dist: inflection==0.3.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: maintainer
+Dynamic: maintainer-email
+Dynamic: requires-dist
+Dynamic: summary
+
+K2 Cloud API Client
 =====================
 
-Simple command-line utility for sending custom requests to CROC Cloud platform.
+Simple command-line utility for sending custom requests to K2 Cloud platform.
 
 **Warning: this utility is not intended for automation cases.
 Use https://github.com/c2devel/boto3.git and python scripts instead.**
@@ -34,11 +47,27 @@ Use https://github.com/c2devel/boto3.git and python scripts instead.**
 Installation
 ------------
 
-Using pip:
+C2client package relies on forked versions of boto3 and botocore from the `C2Devel/boto3 <https://github.com/c2Devel/boto3>`_ and `C2Devel/botocore <https://github.com/c2Devel/botocore>`_ repositories. For isolated use our dependencies, it is highly recommended to use a virtual environment.
+
+
+1. Clone the repository
+
+    .. code-block:: bash 
+
+       git clone https://github.com/C2Devel/c2-client.git && cd c2-client
+       
+2. Setup the virtual environment(Unix based system)
 
-   .. code-block:: bash
+    .. code-block:: bash 
+
+       python3 -m venv .venv && source .venv/bin/activate
+       
+3. Install the package in editable mode along with dependencies from requirements.txt
+
+    .. code-block:: bash
+
+       pip install -e . -r requirements.txt
 
-      $ pip install c2client
 
 Usage
 -----
@@ -74,5 +103,3 @@ Send simple request:
 
    $ c2-ec2 RunInstances ImageId cmi-078880A0 Description "Test instance" \
    InstanceType m1.small MaxCount 1 MinCount 1 SecurityGroup.1 test
-
-

{c2client-0.24 → c2client-0.26}/c2client.egg-info/entry_points.txt

@@ -10,7 +10,9 @@ c2-eks = c2client.clients:EKSClient.execute
 c2-eks-legacy = c2client.clients:LegacyEKSClient.execute
 c2-elb = c2client.clients:ELBClient.execute
 c2-iam = c2client.clients:IAMClient.execute
+c2-kms = c2client.clients:KMSClient.execute
+c2-logs = c2client.clients:LogsClient.execute
 c2-paas = c2client.clients:PaasClient.execute
+c2-rgt = c2client.clients:ResourceGroupsTaggingClient.execute
 c2-route53 = c2client.clients:Route53Client.execute
 c2rc-convert = c2client.c2rc_convert:main
-

{c2client-0.24 → c2client-0.26}/setup.py

@@ -24,6 +24,7 @@ entrypoints = [
     ("c2-bs", "BSClient"),
     ("c2-ct", "CTClient"),
     ("c2-cw", "CWClient"),
+    ("c2-dc", "DirectConnectClient"),
     ("c2-ec2", "EC2Client"),
     ("c2-efs", "EFSClient"),
     ("c2-eks", "EKSClient"),
@@ -31,19 +32,21 @@ entrypoints = [
     ("c2-elb", "ELBClient"),
     ("c2-iam", "IAMClient"),
     ("c2-paas", "PaasClient"),
+    ("c2-rgt", "ResourceGroupsTaggingClient"),
     ("c2-route53", "Route53Client"),
-    ("c2-dc", "DirectConnectClient"),
+    ("c2-kms", "KMSClient"),
+    ("c2-logs", "LogsClient"),
 ]
 
 setup(
     name="c2client",
     version=__version__,
-    description="CROC Cloud Platform - API Client",
+    description="RockitCloud Platform - API Client",
     long_description=get_description(),
     url="https://github.com/c2devel/c2-client",
     license="GPL3",
-    author="CROC Cloud Team",
-    author_email="devel@croc.ru",
+    author="RockitCLoud Team",
+    author_email="devel@k2.cloud",
     maintainer="Andrey Kulaev",
     maintainer_email="adkulaev@gmail.com",
     classifiers=[
@@ -60,6 +63,7 @@ setup(
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
     ],
     install_requires=install_requires,
     packages=find_packages(),

c2client-0.24/c2client/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.24"