cloudsnake 0.6.0__tar.gz → 0.10.0__tar.gz

{cloudsnake-0.6.0 → cloudsnake-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudsnake
-Version: 0.6.0
+Version: 0.10.0
 Summary: Some AWS CLI commands with a beautiful TUI
 License: GPL-3.0
 License-File: LICENSE
@@ -22,15 +22,18 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Dist: boto3 (>=1.41.5,<2.0.0)
+Requires-Dist: boto3 (>=1.42.10,<2.0.0)
+Requires-Dist: boto3-stubs (>=1.42.8,<1.43.0)
 Requires-Dist: click (<8.4.0)
+Requires-Dist: configparser (>=7.2.0,<8.0.0)
 Requires-Dist: dacite (>=1.8.1,<2.0.0)
 Requires-Dist: jmespath (>=1.0.1,<2.0.0)
 Requires-Dist: moto (>=5.0.9,<6.0.0)
-Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: requests (>=2.32.5,<3.0.0)
 Requires-Dist: rich (>=14.2.0,<15.0.0)
 Requires-Dist: simple-term-menu (>=1.6.4,<2.0.0)
-Requires-Dist: typer (>=0.20.0,<0.21.0)
+Requires-Dist: textual (>=7.2.0,<8.0.0)
+Requires-Dist: typer (>=0.20,<0.22)
 Requires-Dist: typing-extensions (>=4.12.0,<5.0.0)
 Project-URL: Documentation, https://github.com/containerscrew/cloudsnake#readme
 Project-URL: Repository, https://github.com/containerscrew/cloudsnake
@@ -38,7 +41,7 @@ Description-Content-Type: text/markdown
 
 <p align="center" >
     <h3 align="center">cloudsnake 🐍</h3>
-    <p align="center">Wrapping some useful AWS cli commands to operate AWS like EC2 SSM instance connection or RDS connection using IAM authentication</p>
+    <p align="center">Wrapping some useful AWS cli commands to operate some services like EC2, SSO and more</p>
 </p>
 
 ---
@@ -55,18 +58,28 @@ Description-Content-Type: text/markdown
     <img alt="PyPiP version" src="https://img.shields.io/pypi/v/cloudsnake">
     <img alt="License" src="https://img.shields.io/github/license/containerscrew/cloudsnake">
     <img alt="Linter" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json">
+    <img alt="PyPip downloads" src="https://img.shields.io/pypi/dm/cloudsnake">
 </p>
 
 ---
 
+In your terminal, set the corresponding `AWS_PROFILE=MyProfile` if not using the default. (`~/.aws/credentials`). Copy [this helper function](./aws-profile.sh) called `aws-profile` into your favourite shell (`.bashrc`, `.zshrc`, `~/.config/fish/function`) to easily switch between AWS profiles. In case of using `fish` shell, use [this other function](./aws-profile.fish).
+
+<br><br>
 <p align="center">
-    <img align="center" alt="SSM session" src="docs/img//cloudsnake-ssm-session.gif">
+    <img align="center" alt="SSM session" src="docs/img/aws-profile.gif">
+<h3 align="center">aws-profile</h3>
+</p>
+
+---
+<br><br>
+<p align="center">
+    <img align="center" alt="SSM session" src="docs/img/cloudsnake-ssm-session.gif">
 <h3 align="center">SSM session</h3>
 </p>
 
-In your terminal, set the corresponding `AWS_PROFILE=MyProfile` if not using the default. (`~/.aws/credentials`). Also install the [REQUIRED plugin](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html) to use SSM sessions.
+Install the [REQUIRED plugin](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html) to use SSM sessions.
 
-Then run:
 
 ```shell
 cloudsnake ssm start-session -is # will print all your instances in a terminal menu
@@ -75,15 +88,46 @@ cloudsnake ssm start-session --target i-XXXXXX  # connect to the instance specif
 
 ---
 
+<br><br>
 <p align="center">
     <img align="center" alt="SSM get parameter" src="docs/img/cloudsnake-ssm-parameter.gif">
-<h3 align="center">SSM get parameter</h3>
+<h3 align="center">SSM parameter</h3>
 </p>
 
 ```shell
 cloudsnake ssm get-parameter # default region eu-west-1
 cloudsnake --region us-east-1 ssm get-parameters # specify region
 ```
+---
+
+<br><br>
+<p align="center">
+    <img align="center" alt="SSO get-credentials" src="docs/img/cloudsnake-sso-credentials.png">
+<h3 align="center">SSO get-credentials</h3>
+</p>
+
+```shell
+cloudsnake --region eu-west-1 sso get-credentials --start-url https://myapp.awsapps.com/start
+```
+
+> [!NOTE]
+> This command will open your default browser. You will need to approve manually the authentication.
+> More use cases and examples for `cloudsnake sso get-credentials` can be found in [`docs/sso-get-credentials.md`](./docs/sso-get-credentials.md).
+
+---
+
+<br><br>
+<p align="center">
+    <img align="center" alt="Cloudwatch log stream" src="docs/img/cloudsnake-logs-stream.gif">
+<h3 align="center">Cloudwatch log stream</h3>
+</p>
+
+```shell
+cloudsnake logs stream
+cloudsnake logs stream --filter-pattern "ERROR"
+```
+> [!NOTE]
+> By the moment, `logs stream` only supports viewing logs from the moment you start the command. Future versions will include the ability to view historical logs.
 
 # Installation
 
@@ -132,14 +176,26 @@ hint: See PEP 668 for the detailed specification.
 </pre>
 </details>
 
+# Upgrade
+
+```bash
+pipx upgrade cloudsnake
+```
+
 # Uninstall
 
-```console
+```bash
 pipx uninstall cloudsnake
 # or
 pip3 uninstall cloudsnake
 ```
 
+## Debug AWS SDK API calls
+
+```shell
+cloudsnake --log-level debug command subcommand [options]
+```
+
 # License
 
 `cloudsnake` is distributed under the terms of the [GPL3](https://spdx.org/licenses/GPL-3.0-or-later.html) license.

{cloudsnake-0.6.0 → cloudsnake-0.10.0}/README.md

@@ -1,6 +1,6 @@
 <p align="center" >
     <h3 align="center">cloudsnake 🐍</h3>
-    <p align="center">Wrapping some useful AWS cli commands to operate AWS like EC2 SSM instance connection or RDS connection using IAM authentication</p>
+    <p align="center">Wrapping some useful AWS cli commands to operate some services like EC2, SSO and more</p>
 </p>
 
 ---
@@ -17,18 +17,28 @@
     <img alt="PyPiP version" src="https://img.shields.io/pypi/v/cloudsnake">
     <img alt="License" src="https://img.shields.io/github/license/containerscrew/cloudsnake">
     <img alt="Linter" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json">
+    <img alt="PyPip downloads" src="https://img.shields.io/pypi/dm/cloudsnake">
 </p>
 
 ---
 
+In your terminal, set the corresponding `AWS_PROFILE=MyProfile` if not using the default. (`~/.aws/credentials`). Copy [this helper function](./aws-profile.sh) called `aws-profile` into your favourite shell (`.bashrc`, `.zshrc`, `~/.config/fish/function`) to easily switch between AWS profiles. In case of using `fish` shell, use [this other function](./aws-profile.fish).
+
+<br><br>
 <p align="center">
-    <img align="center" alt="SSM session" src="docs/img//cloudsnake-ssm-session.gif">
+    <img align="center" alt="SSM session" src="docs/img/aws-profile.gif">
+<h3 align="center">aws-profile</h3>
+</p>
+
+---
+<br><br>
+<p align="center">
+    <img align="center" alt="SSM session" src="docs/img/cloudsnake-ssm-session.gif">
 <h3 align="center">SSM session</h3>
 </p>
 
-In your terminal, set the corresponding `AWS_PROFILE=MyProfile` if not using the default. (`~/.aws/credentials`). Also install the [REQUIRED plugin](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html) to use SSM sessions.
+Install the [REQUIRED plugin](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html) to use SSM sessions.
 
-Then run:
 
 ```shell
 cloudsnake ssm start-session -is # will print all your instances in a terminal menu
@@ -37,15 +47,46 @@ cloudsnake ssm start-session --target i-XXXXXX  # connect to the instance specif
 
 ---
 
+<br><br>
 <p align="center">
     <img align="center" alt="SSM get parameter" src="docs/img/cloudsnake-ssm-parameter.gif">
-<h3 align="center">SSM get parameter</h3>
+<h3 align="center">SSM parameter</h3>
 </p>
 
 ```shell
 cloudsnake ssm get-parameter # default region eu-west-1
 cloudsnake --region us-east-1 ssm get-parameters # specify region
 ```
+---
+
+<br><br>
+<p align="center">
+    <img align="center" alt="SSO get-credentials" src="docs/img/cloudsnake-sso-credentials.png">
+<h3 align="center">SSO get-credentials</h3>
+</p>
+
+```shell
+cloudsnake --region eu-west-1 sso get-credentials --start-url https://myapp.awsapps.com/start
+```
+
+> [!NOTE]
+> This command will open your default browser. You will need to approve manually the authentication.
+> More use cases and examples for `cloudsnake sso get-credentials` can be found in [`docs/sso-get-credentials.md`](./docs/sso-get-credentials.md).
+
+---
+
+<br><br>
+<p align="center">
+    <img align="center" alt="Cloudwatch log stream" src="docs/img/cloudsnake-logs-stream.gif">
+<h3 align="center">Cloudwatch log stream</h3>
+</p>
+
+```shell
+cloudsnake logs stream
+cloudsnake logs stream --filter-pattern "ERROR"
+```
+> [!NOTE]
+> By the moment, `logs stream` only supports viewing logs from the moment you start the command. Future versions will include the ability to view historical logs.
 
 # Installation
 
@@ -94,14 +135,26 @@ hint: See PEP 668 for the detailed specification.
 </pre>
 </details>
 
+# Upgrade
+
+```bash
+pipx upgrade cloudsnake
+```
+
 # Uninstall
 
-```console
+```bash
 pipx uninstall cloudsnake
 # or
 pip3 uninstall cloudsnake
 ```
 
+## Debug AWS SDK API calls
+
+```shell
+cloudsnake --log-level debug command subcommand [options]
+```
+
 # License
 
 `cloudsnake` is distributed under the terms of the [GPL3](https://spdx.org/licenses/GPL-3.0-or-later.html) license.

{cloudsnake-0.6.0 → cloudsnake-0.10.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "cloudsnake"
-version = "0.6.0"
+version = "0.10.0"
 description = 'Some AWS CLI commands with a beautiful TUI'
 authors = ["containerscrew <info@containerscrew.com>"]
 repository = "https://github.com/containerscrew/cloudsnake"
@@ -26,7 +26,7 @@ classifiers = [
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
 
-include = [{ path = "tests", format = "sdist" }, { path = "CHANGELOG.md" }]
+include = [{ path = "tests", format = "sdist" }, { path = "CHANGELOG.md" }, { path = "src/cloudsnake/styles/*.tcss"}]
 
 [tool.poetry.scripts]
 cloudsnake = 'cloudsnake.__main__:main'
@@ -41,13 +41,16 @@ pytest-cov = "^7.0.0"
 
 [tool.poetry.dependencies]
 python = "^3.12"
-boto3 = "^1.41.5"
+boto3 = "^1.42.10"
 click = "<8.4.0"
 dacite = "^1.8.1"
 simple-term-menu = "^1.6.4"
-typer = "^0.20.0"
+typer = ">=0.20,<0.22"
 typing-extensions = "^4.12.0"
 rich = "^14.2.0"
 jmespath = "^1.0.1"
 moto = "^5.0.9"
-requests = "^2.32.3"
+requests = "^2.32.5"
+boto3-stubs = "~=1.42.8"
+configparser = "^7.2.0"
+textual = "^7.2.0"

{cloudsnake-0.6.0 → cloudsnake-0.10.0}/src/cloudsnake/cli/cli.py

@@ -2,8 +2,12 @@ import os
 import typer
 from typing import Optional
 from importlib.metadata import version
+
+
 from cloudsnake.cli.dto import Common, LoggingLevel
+from cloudsnake.cli.logs import cw_logs
 from cloudsnake.cli.ssm import ssm
+from cloudsnake.cli.sso import sso
 from cloudsnake.sdk.session import SessionWrapper
 from cloudsnake.logger import init_logger
 from rich import traceback
@@ -16,7 +20,7 @@ APP_VERSION = version("cloudsnake")
 # Declare app and add subcommands
 app = typer.Typer(
     name="cloudsnake",
-    help="🐍☁  A modern CLI to interact with AWS resources (EC2, SSM, RDS). By github.com/containerscrew",
+    help=f"🐍 A modern CLI to interact with AWS resources. (c) 2025 containerscrew - version {APP_VERSION}",
     no_args_is_help=True,
     pretty_exceptions_short=True,
     pretty_exceptions_show_locals=False,
@@ -24,17 +28,8 @@ app = typer.Typer(
 )
 
 app.add_typer(ssm, name="ssm", help="Manage SSM operations")
-
-
-@app.command("version", help="Show cloudsnake app version")
-def version_cmd():
-    typer.echo(
-        typer.style(
-            f"cloudsnake version: {APP_VERSION}",
-            fg=typer.colors.GREEN,
-            bold=True,
-        )
-    )
+app.add_typer(sso, name="sso", help="Manage SSO operations")
+app.add_typer(cw_logs, name="logs", help="Manage CloudWatch Logs operations")
 
 
 @app.callback()
@@ -63,7 +58,14 @@ def entrypoint(
     Entry point for the cloudsnake CLI.
     """
     logger = init_logger(log_level.value)
-    logger.info("Initializing cloudsnake 🐍☁")
+
+    typer.echo(
+        typer.style(
+            f"~> cloudsnake 🐍 - version {APP_VERSION}",
+            fg=typer.colors.CYAN,
+            bold=True,
+        )
+    )
 
     # Create resources
     session = SessionWrapper(profile, region).with_local_session()

{cloudsnake-0.6.0 → cloudsnake-0.10.0}/src/cloudsnake/cli/dto.py

@@ -10,6 +10,19 @@ class Common:
     region: str
 
 
+@dataclass
+class DeviceRegistration:
+    client_id: str
+    client_secret: str
+
+
+@dataclass
+class DeviceCode:
+    device_code: str
+    user_code: str
+    verification_uri_complete: str
+
+
 class OutputMode(str, Enum):
     json = "json"
     table = "table"

cloudsnake-0.10.0/src/cloudsnake/cli/logs.py

@@ -0,0 +1,74 @@
+import signal
+import sys
+import typer
+
+from cloudsnake.helpers import (
+    log_groups_to_items,
+    normalize_log_group_arn_for_live_tail,
+)
+from cloudsnake.sdk.cloudwatch import CloudWatchLogsWrapper, print_colored_log
+from cloudsnake.tui_v2 import SelectorApp
+
+DEFAULT_LOG_FILTER = "[].{logGroupName: logGroupName, size: storedBytes, arn: arn}"
+
+
+def signal_handler(sig, frame):
+    typer.secho("You pressed Ctrl+C! Exiting gracefully...", fg="bright_red")
+    sys.exit(0)
+
+
+cw_logs = typer.Typer(
+    no_args_is_help=True,
+    pretty_exceptions_short=True,
+    pretty_exceptions_show_locals=False,
+)
+
+
+@cw_logs.command(
+    "stream", help="Live stream logs from a CloudWatch log group", no_args_is_help=False
+)
+def start_session(
+    ctx: typer.Context,
+    filter_pattern: str = typer.Option(
+        None,
+        "--filter-pattern",
+        "-f",
+        help="Filter pattern for log events",
+    ),
+):
+    signal.signal(signal.SIGINT, signal_handler)
+    cw = CloudWatchLogsWrapper(
+        session=ctx.obj.session,
+        profile=ctx.obj.profile,
+        region=ctx.obj.region,
+        query=DEFAULT_LOG_FILTER,
+    )
+    log_groups = cw.list_log_groups()
+    items = log_groups_to_items(log_groups)
+    app = SelectorApp(
+        items=items,
+        title=f"🚀 AWS Cloudwatch log groups — {ctx.obj.profile}",
+        placeholder="Type to filter log groups...",
+    )
+    selected_log_group = app.run()
+
+    if selected_log_group:
+        log_group_arn = next(
+            g["arn"] for g in log_groups if g["logGroupName"] == selected_log_group
+        )
+        typer.secho(
+            f"~> Starting live tail for log group: {selected_log_group}",
+            fg="bright_green",
+        )
+        try:
+            for event in cw.tail_log_group_live(
+                log_group_arn=normalize_log_group_arn_for_live_tail(log_group_arn),
+                filter_pattern=filter_pattern,
+            ):
+                print_colored_log(event, highlight_term=filter_pattern)
+        except KeyboardInterrupt:
+            typer.secho("\nStopped.", fg="bright_yellow")
+    else:
+        typer.secho("~> No log group selected", fg="bright_yellow")
+        raise typer.Exit(1)
+    return

cloudsnake-0.10.0/src/cloudsnake/cli/ssm.py

@@ -0,0 +1,135 @@
+import signal
+import sys
+from typing import Optional
+from cloudsnake.helpers import ec2_targets_to_items, ssm_parameters_to_items
+from cloudsnake.sdk.ssm_parameters import SSMParameterStoreWrapper
+from cloudsnake.tui import EC2Tui, SSMTui
+import typer
+
+from cloudsnake.sdk.ec2 import EC2InstanceWrapper
+from cloudsnake.sdk.ssm_session import SSMStartSessionWrapper
+from cloudsnake.tui_v2 import SelectorApp
+
+EC2_RUNNING_FILTER = "Name=instance-state-name,Values=running"
+
+EC2_INSTANCE_SELECTOR_QUERY = "[].{TargetId: InstanceId, Name: Tags[?Key=='Name'].Value | [0], Ip: PrivateIpAddress}"
+
+# TUI
+ec2_tui = EC2Tui()
+ssm_tui = SSMTui()
+
+
+def signal_handler(sig, frame):
+    typer.secho("You pressed Ctrl+C! Exiting gracefully...", fg="bright_red")
+    sys.exit(0)
+
+
+ssm = typer.Typer(
+    no_args_is_help=True,
+    pretty_exceptions_short=True,
+    pretty_exceptions_show_locals=False,
+)
+
+
+@ssm.command(
+    "start-session", help="Start session with the given target id", no_args_is_help=True
+)
+def start_session(
+    ctx: typer.Context,
+    target: Optional[str] = typer.Option(None, help="Target id of the instance"),
+    reason: Optional[str] = typer.Option(
+        "ssm-new-connection", help="Reason of the connection"
+    ),
+    with_instance_selector: Optional[bool] = typer.Option(
+        False,
+        "--with-instance-selector",
+        "-is",
+        help="Prompt a terminal menu and select the instance you want to connect. --target flag is no longer used",
+    ),
+):
+    signal.signal(signal.SIGINT, signal_handler)
+    ssm_wrapper = SSMStartSessionWrapper(
+        session=ctx.obj.session,
+        profile=ctx.obj.profile,
+        region=ctx.obj.region,
+    )
+
+    if with_instance_selector:
+        ec2 = EC2InstanceWrapper(
+            session=ctx.obj.session,
+            filters=EC2_RUNNING_FILTER,
+            query=EC2_INSTANCE_SELECTOR_QUERY,
+            profile=ctx.obj.profile,
+            region=ctx.obj.region,
+        )
+
+        # Fake data for testing
+        # instances = [
+        #     {"TargetId": "i-003a434fb9c00f0f8", "Name": "WebServer-01", "Ip": "10.100.0.2"},
+        #     {"TargetId": "i-0c7cca12079e449a5", "Name": "eks-instance-nodegroup-apps", "Ip": "10.100.0.3"},
+        #     {"TargetId": "i-06ad6856a7ca778c6", "Name": "Database-Primary", "Ip": "10.100.0.4"},
+        #     {"TargetId": "i-050ed4067698e7d26", "Name": "Cache-Server-01", "Ip": "10.100.0.5"},
+        # ]
+
+        instances = ec2.describe_ec2_instances()
+
+        if not instances:
+            typer.secho("~> No running instances found", fg="bright_yellow")
+            raise typer.Exit(1)
+
+        items = ec2_targets_to_items(instances)
+
+        app = SelectorApp(
+            items=items,
+            title=f"🚀 EC2 Instances — {ctx.obj.profile}",
+            placeholder="Type to filter by name or ID...",
+        )
+
+        result_id = app.run()
+
+        if result_id:
+            selected = next(item for item in instances if item["TargetId"] == result_id)
+            instance_id = selected["TargetId"]
+            return ssm_wrapper.start_session(instance_id, reason)
+        else:
+            typer.secho("~> No instance selected", fg="bright_yellow")
+            raise typer.Exit(1)
+
+    return ssm_wrapper.start_session(target, reason)
+
+
+@ssm.command("get-parameters", help="Get secrets from parameter store")
+def get_parameters(
+    ctx: typer.Context,
+):
+    signal.signal(signal.SIGINT, signal_handler)
+    ssm_wrapper = SSMParameterStoreWrapper(
+        session=ctx.obj.session,
+        profile=ctx.obj.profile,
+        region=ctx.obj.region,
+    )
+
+    parameters = ssm_wrapper.describe_parameters()
+
+    # fake_parameters= [
+    #     {"Name": "/myapp/db_password", "Type": "SecureString"},
+    #     {"Name": "/myapp/db_endpoint", "Type": "SecureString"},
+    #     {"Name": "/myapp/redis_password", "Type": "SecureString"},
+    #     {"Name": "/myapp/google_oauth", "Type": "SecureString"},
+    # ]
+
+    items = ssm_parameters_to_items(parameters)
+
+    if not parameters:
+        typer.echo("No parameters found.")
+        raise typer.Exit(1)
+
+    app = SelectorApp(
+        items=items,
+        title=f"🚀 SSM Parameter — {ctx.obj.profile}",
+        placeholder="Type to filter by name ...",
+    )
+
+    result_id = app.run()
+    parameter = ssm_wrapper.get_parameter_by_name(result_id)
+    typer.secho(f"~> {parameter}", fg="bright_green")