clear-skies-aws 2.0.3__tar.gz → 2.0.5__tar.gz

{clear_skies_aws-2.0.3 → clear_skies_aws-2.0.5}/.pre-commit-config.yaml

@@ -8,9 +8,6 @@ ci:
 default_install_hook_types:
     - pre-commit
     - commit-msg
-    - post-checkout
-    - post-merge
-    - post-rewrite
 
 default_stages: ["pre-commit"]
 
@@ -69,7 +66,7 @@ repos:
     hooks:
       - id: pytest
         name: pytest
-        entry: uv run pytest .
+        entry: uv run pytest . -m "not broken"
         language: system
         types: [python]
         pass_filenames: false

{clear_skies_aws-2.0.3 → clear_skies_aws-2.0.5}/CHANGELOG.md

@@ -5,9 +5,27 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.5] - 2026-01-12
+
+### Added
+- Add ssm portforwarder in [#9](https://github.com/clearskies-py/aws/pull/9)
+
+## [2.0.4] - 2026-01-09
+
+### Added
+- Add rds mysql cursor
+
+### Changed
+- Bump version to v2.0.4 by @github-actions[bot]
+- Use the port forwarder class in [#8](https://github.com/clearskies-py/aws/pull/8)
+
+### Fixed
+- Make age dynamic instead of fixed
+
 ## [2.0.3] - 2026-01-05
 
 ### Changed
+- Bump version to v2.0.3 by @github-actions[bot]
 - Merge pull request #7 from clearskies-py/contexts by @cmancone in [#7](https://github.com/clearskies-py/aws/pull/7)
 - Require latest clearskies version per added feature by @cmancone
 - Bring up-to-date by @cmancone
@@ -77,6 +95,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * @cmancone made their first contribution
 * @ made their first contribution
 * @github-actions[bot] made their first contribution
+[2.0.5]: https://github.com/clearskies-py/aws/compare/v2.0.4..v2.0.5
+[2.0.4]: https://github.com/clearskies-py/aws/compare/v2.0.3..v2.0.4
 [2.0.3]: https://github.com/clearskies-py/aws/compare/v2.0.2..v2.0.3
 [2.0.2]: https://github.com/clearskies-py/aws/compare/v2.0.1..v2.0.2
 

clear_skies_aws-2.0.5/LATEST_CHANGELOG.md

@@ -0,0 +1,5 @@
+## [2.0.5] - 2026-01-12
+
+### Added
+- Add ssm portforwarder in [#9](https://github.com/clearskies-py/aws/pull/9)
+

{clear_skies_aws-2.0.3 → clear_skies_aws-2.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clear-skies-aws
-Version: 2.0.3
+Version: 2.0.5
 Summary: clearskies bindings for working in AWS
 Project-URL: Repository, https://github.com/clearskies-py/clearskies-aws
 Project-URL: Issues, https://github.com/clearskies-py/clearskies-aws/issues
@@ -17,10 +17,12 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: <4.0,>=3.11
 Requires-Dist: boto3<2.0.0,>=1.26.148
 Requires-Dist: clear-skies<3.0.0,>=2.0.20
-Requires-Dist: types-boto3[dynamodb,sns,sqs]<2.0.0,>=1.38.13
+Requires-Dist: types-boto3[dynamodb,secretsmanager,ses,sns,sqs,ssm,stepfunctions]<2.0.0,>=1.38.13
 Provides-Extra: akeyless
 Requires-Dist: akeyless-cloud-id<0.5.0,>=0.2.3; extra == 'akeyless'
 Requires-Dist: akeyless<6.0.0,>=5.0.0; extra == 'akeyless'
+Provides-Extra: mysql
+Requires-Dist: clear-skies[mysql]; extra == 'mysql'
 Provides-Extra: ses
 Requires-Dist: jinja2<4.0.0,>=3.1.2; extra == 'ses'
 Description-Content-Type: text/markdown

{clear_skies_aws-2.0.3 → clear_skies_aws-2.0.5}/pyproject.toml

@@ -3,14 +3,14 @@
 name = "clear-skies-aws"
 description = "clearskies bindings for working in AWS"
 license = "MIT"
-version = "2.0.3"
+version = "2.0.5"
 readme = "./README.md"
 authors = [{name = "tnijboer"}, {name = "Conor Mancone", email = "cmancone@gmail.com"}]
 requires-python = '>=3.11,<4.0'
 dependencies = [
     'boto3 (>=1.26.148,<2.0.0)',
-    'clear-skies (>=2.0.20,<3.0.0)',
-    'types-boto3[dynamodb,sns,sqs] (>=1.38.13,<2.0.0)',
+    "clear-skies>=2.0.20,<3.0.0",
+    'types-boto3[dynamodb,sns,sqs,ses,ssm,secretsmanager,stepfunctions] (>=1.38.13,<2.0.0)',
 ]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
@@ -28,6 +28,7 @@ Documentation = "https://clearskies.info/modules/clearskies-aws/"
 [project.optional-dependencies]
 akeyless = ['akeyless-cloud-id (>=0.2.3,<0.5.0)', 'akeyless (>=5.0.0,<6.0.0)']
 ses = ['jinja2 (>=3.1.2,<4.0.0)']
+mysql = ['clear-skies[mysql]']
 
 [build-system]
 requires = ["hatchling"]
@@ -55,7 +56,8 @@ python_version = "3.11"
 
 exclude = [
     ".*_test\\.py$",
-    "docs/.*"
+    "docs/.*",
+    "tests/.*"
 ]
 
 [tool.pytest.ini_options]

{clear_skies_aws-2.0.3 → clear_skies_aws-2.0.5}/src/clearskies_aws/__init__.py

@@ -4,6 +4,7 @@ from clearskies_aws import (
     actions,
     backends,
     contexts,
+    cursors,
     di,
     endpoints,
     handlers,
@@ -17,6 +18,7 @@ __all__ = [
     "actions",
     "backends",
     "contexts",
+    "cursors",
     "di",
     "endpoints",
     "handlers",

{clear_skies_aws-2.0.3 → clear_skies_aws-2.0.5}/src/clearskies_aws/backends/__init__.py

@@ -1,9 +1,9 @@
 from __future__ import annotations
 
 from clearskies_aws.backends.backend import Backend
-from clearskies_aws.backends.dynamo_db_backend import DynamoDBBackend
-from clearskies_aws.backends.dynamo_db_condition_parser import DynamoDBConditionParser
-from clearskies_aws.backends.dynamo_db_parti_ql_backend import (
+from clearskies_aws.backends.dynamo_db_backend import DynamoDBBackend  # type: ignore
+from clearskies_aws.backends.dynamo_db_condition_parser import DynamoDBConditionParser  # type: ignore
+from clearskies_aws.backends.dynamo_db_parti_ql_backend import (  # type: ignore
     DynamoDBPartiQLBackend,
     DynamoDBPartiQLCursor,
 )

{clear_skies_aws-2.0.3 → clear_skies_aws-2.0.5}/src/clearskies_aws/backends/dynamo_db_backend.py

@@ -1,3 +1,4 @@
+# type: ignore
 from __future__ import annotations
 
 import base64

{clear_skies_aws-2.0.3 → clear_skies_aws-2.0.5}/src/clearskies_aws/backends/dynamo_db_condition_parser.py

@@ -1,3 +1,4 @@
+# type: ignore
 from __future__ import annotations
 
 import base64

{clear_skies_aws-2.0.3 → clear_skies_aws-2.0.5}/src/clearskies_aws/backends/dynamo_db_parti_ql_backend.py

@@ -1,3 +1,5 @@
+# type: ignore
+
 from __future__ import annotations
 
 import base64

{clear_skies_aws-2.0.3 → clear_skies_aws-2.0.5}/src/clearskies_aws/contexts/lambda_api_gateway_web_socket.py

@@ -73,7 +73,7 @@ class LambdaApiGatewayWebSocket(Context):
 
     """
 
-    def __call__(
+    def __call__(  # type: ignore[override]
         self, event: dict[str, Any], context: dict[str, Any], url: str = "", request_method: str = ""
-    ) -> dict[str, Any]:  # type: ignore[override]
+    ) -> dict[str, Any]:
         return self.execute_application(LambdaApiGatewayWebSocketInputOutput(event, context, url))

{clear_skies_aws-2.0.3 → clear_skies_aws-2.0.5}/src/clearskies_aws/contexts/lambda_invoke.py

@@ -125,9 +125,9 @@ class LambdaInvoke(Context):
 
     """
 
-    def __call__(
+    def __call__(  # type: ignore[override]
         self, event: dict[str, Any], context: dict[str, Any], request_method: str = "", url: str = ""
-    ) -> dict[str, Any]:  # type: ignore[override]
+    ) -> dict[str, Any]:
         return self.execute_application(
             LambdaInvokeInputOutput(
                 event,

{clear_skies_aws-2.0.3 → clear_skies_aws-2.0.5}/src/clearskies_aws/contexts/lambda_sqs_standard.py

@@ -120,9 +120,9 @@ class LambdaSqsStandard(Context):
 
     """
 
-    def __call__(
+    def __call__(  # type: ignore[override]
         self, event: dict[str, Any], context: dict[str, Any], url: str = "", request_method: str = ""
-    ) -> dict[str, Any]:  # type: ignore[override]
+    ) -> dict[str, Any]:
         item_failures = []
         for record in event["Records"]:
             try:

clear_skies_aws-2.0.5/src/clearskies_aws/cursors/__init__.py

@@ -0,0 +1,3 @@
+from clearskies_aws.cursors import iam, port_forwarding
+
+__all__ = ["iam", "port_forwarding"]

clear_skies_aws-2.0.5/src/clearskies_aws/cursors/iam/__init__.py

@@ -0,0 +1,7 @@
+import logging
+
+from clearskies_aws.cursors.iam.rds_mysql import RdsMysql
+
+logging.getLogger(__name__)
+
+__all__ = ["RdsMysql"]

clear_skies_aws-2.0.5/src/clearskies_aws/cursors/iam/rds_mysql.py

@@ -0,0 +1,125 @@
+"""
+RdsMySql: MySQL cursor with AWS RDS IAM authentication.
+
+This class provides a MySQL cursor that uses AWS RDS IAM DB authentication.
+It loads connection parameters from environment variables and generates a temporary
+IAM authentication token for secure database access.
+
+Configuration fields:
+    - boto3: Injected boto3 provider for AWS API access.
+    - environment: Injected environment variable provider.
+    - hostname_environment_key: Environment variable for DB host (default: "DATABASE_HOST").
+    - username_environment_key: Environment variable for DB user (default: "DATABASE_USERNAME").
+    - database_environment_key: Environment variable for DB name (default: "DATABASE_NAME").
+    - port_environment_key: Environment variable for DB port (default: "DATABASE_PORT").
+    - cert_path_environment_key: Environment variable for SSL CA cert (default: "DATABASE_CERT_PATH").
+    - autocommit_environment_key: Environment variable for autocommit (default: "DATABASE_AUTOCOMMIT").
+    - connect_timeout_environment_key: Environment variable for connect timeout (default: "DATABASE_CONNECT_TIMEOUT").
+    - database_region_key: Environment variable for AWS region (default: "DATABASE_REGION").
+
+Example:
+    import clearskies_aws.cursors.iam.rds_mysql
+
+    cursor = clearskies_aws.cursors.iam.rds_mysql.RdsMySql()
+    cursor.execute("SELECT 1")
+"""
+
+import os
+from typing import Any
+
+import clearskies
+from clearskies import decorators
+from clearskies.cursors import Mysql
+
+from clearskies_aws.di import inject
+
+
+class RdsMysql(Mysql):
+    """MySQL cursor with AWS RDS IAM DB authentication."""
+
+    """Injected boto3 provider for AWS API access."""
+    boto3 = inject.Boto3()
+
+    """Injected environment variable provider."""
+    environment = clearskies.di.inject.Environment()
+
+    """Environment variable for DB host (default: "DATABASE_HOST")."""
+    hostname_environment_key = clearskies.configs.String(default="DATABASE_HOST")
+
+    """Environment variable for DB user (default: "DATABASE_USERNAME")."""
+    username_environment_key = clearskies.configs.String(default="DATABASE_USERNAME")
+
+    """Environment variable for DB name (default: "DATABASE_NAME")."""
+    database_environment_key = clearskies.configs.String(default="DATABASE_NAME")
+
+    """Environment variable for DB port (default: "DATABASE_PORT")."""
+    port_environment_key = clearskies.configs.String(default="DATABASE_PORT")
+
+    """Environment variable for SSL CA cert (default: "DATABASE_CERT_PATH")."""
+    cert_path_environment_key = clearskies.configs.String(default="DATABASE_CERT_PATH")
+
+    """Environment variable for autocommit (default: "DATABASE_AUTOCOMMIT")."""
+    autocommit_environment_key = clearskies.configs.String(default="DATABASE_AUTOCOMMIT")
+
+    """Environment variable for connect timeout (default: "DATABASE_CONNECT_TIMEOUT")."""
+    connect_timeout_environment_key = clearskies.configs.String(default="DATABASE_CONNECT_TIMEOUT")
+
+    """Environment variable for AWS region (default: "DATABASE_REGION")."""
+    database_region_key = clearskies.configs.String(default="DATABASE_REGION")
+
+    @decorators.parameters_to_properties
+    def __init__(
+        self,
+        hostname_environment_key: str | None = None,
+        username_environment_key: str | None = None,
+        database_environment_key: str | None = None,
+        port_environment_key: str | None = None,
+        cert_path_environment_key: str | None = None,
+        autocommit_environment_key: str | None = None,
+        database_region_key: str | None = None,
+        connect_timeout_environment_key: str | None = None,
+        port_forwarding: Any | None = None,
+    ):
+        self.finalize_and_validate_configuration()
+
+    def build_connection_kwargs(self) -> dict:
+        """
+        Build the connection kwargs for the MySQL client, using IAM DB authentication.
+
+        Returns
+        -------
+        dict
+            Connection parameters for the MySQL client.
+        """
+        connection_kwargs = {
+            "user": self.environment.get(self.username_environment_key),
+            "host": self.environment.get(self.hostname_environment_key),
+            "database": self.environment.get(self.database_environment_key),
+            "port": int(self.environment.get(self.port_environment_key, silent=True) or self.port),
+            "ssl_ca": self.environment.get(self.cert_path_environment_key, silent=True),
+            "autocommit": self.environment.get(self.autocommit_environment_key, silent=True),
+            "connect_timeout": int(
+                self.environment.get(self.connect_timeout_environment_key, silent=True) or self.connect_timeout
+            ),
+        }
+        region: str = self.environment.get(self.database_region_key, True) or self.environment.get("AWS_REGION", True)
+        if not region:
+            raise ValueError(
+                "To use RDS IAM DB auth you must set DATABASE_REGION or AWS_REGION in the .env file or an environment variable"
+            )
+        os.environ["LIBMYSQL_ENABLE_CLEARTEXT_PLUGIN"] = "1"
+
+        rds_api = self.boto3.Session().client("rds")
+        rds_token = rds_api.generate_db_auth_token(
+            DBHostname=connection_kwargs.get("host"),
+            Port=connection_kwargs.get("port", 3306),
+            DBUsername=connection_kwargs.get("user"),
+            Region=region,
+        )
+        connection_kwargs["password"] = rds_token
+
+        for kwarg in ["autocommit", "connect_timeout", "port", "ssl_ca"]:
+            if not connection_kwargs[kwarg]:
+                del connection_kwargs[kwarg]
+
+        return {**super().build_connection_kwargs(), **connection_kwargs}

clear_skies_aws-2.0.5/src/clearskies_aws/cursors/port_forwarding/__init__.py

@@ -0,0 +1,3 @@
+from clearskies_aws.cursors.port_forwarding.ssm import Ssm
+
+__all__ = ["Ssm"]

clear_skies_aws-2.0.5/src/clearskies_aws/cursors/port_forwarding/ssm.py

@@ -0,0 +1,137 @@
+import time
+
+import clearskies.configs
+from clearskies import decorators
+from clearskies.cursors.port_forwarding.port_forwarder import PortForwarder
+
+from clearskies_aws.di import inject
+
+
+class Ssm(PortForwarder):
+    """
+    Port forwarder using AWS SSM Session Manager.
+
+    This class sets up a local port forwarding tunnel to a remote host using AWS SSM.
+    If instance_id is not provided, it will search for a running instance by Name tag.
+    """
+
+    """
+    The EC2 instance ID to connect to. If not provided, instance_name will be used to look up the instance.
+    """
+    instance_id = clearskies.configs.String(default=None)
+
+    """
+    The Name tag of the EC2 instance to search for if instance_id is not provided.
+    """
+    instance_name = clearskies.configs.String(default=None)
+
+    """
+    The remote port to forward to.
+    """
+    remote_port = clearskies.configs.Integer()
+
+    """
+    The local port to bind for the forwarding tunnel (default: 0, auto-selects a free port).
+    """
+    local_port = clearskies.configs.Integer(default=0)
+
+    """
+    AWS region.
+    """
+    region = clearskies.configs.String(default=None)
+
+    """
+    AWS CLI profile.
+    """
+    profile = clearskies.configs.String(default=None)
+
+    """
+    Boto3 session or client provider
+    """
+    boto3 = inject.Boto3()
+
+    @decorators.parameters_to_properties
+    def __init__(
+        self,
+        instance_id=None,
+        instance_name=None,
+        remote_port=None,
+        local_port=0,
+        region=None,
+        profile=None,
+    ):
+        self._proc = None
+        self.finalize_and_validate_configuration()
+
+    def setup(self, original_host: str, original_port: int) -> tuple[str, int]:
+        """
+        Establish the port forwarding tunnel and return the local endpoint.
+
+        If instance_id is not set, searches for a running instance by Name tag.
+
+        Returns:
+            A tuple containing the local host and local port to connect to (e.g., ("localhost", 12345)).
+        """
+        # Resolve instance_id if needed
+        if not self.instance_id and self.instance_name:
+            ec2_api = self.boto3.client("ec2", region_name=self.region)
+            running_instances = ec2_api.describe_instances(
+                Filters=[
+                    {"Name": "tag:Name", "Values": [self.instance_name]},
+                    {"Name": "instance-state-name", "Values": ["running"]},
+                ]
+            )
+            instance_ids = []
+            for reservation in running_instances["Reservations"]:
+                for instance in reservation["Instances"]:
+                    instance_ids.append(instance["InstanceId"])
+            if len(instance_ids) == 0:
+                raise ValueError("Failed to launch SSM tunnel! Cannot find bastion!")
+            self.instance_id = instance_ids.pop()
+
+        if self.local_port == 0:
+            self.local_port = self.pick_free_port("127.0.0.1")
+
+        if self.is_port_open("127.0.0.1", self.local_port):
+            return "127.0.0.1", self.local_port
+
+        ssm_cmd = [
+            "aws",
+            "ssm",
+            "start-session",
+            "--target",
+            self.instance_id,
+            "--document-name",
+            "AWS-StartPortForwardingSession",
+            "--parameters",
+            f"portNumber={self.remote_port},localPort={self.local_port}",
+        ]
+        if self.region:
+            ssm_cmd += ["--region", self.region]
+        if self.profile:
+            ssm_cmd += ["--profile", self.profile]
+
+        self._proc = self.subprocess.Popen(ssm_cmd, stdout=self.subprocess.PIPE, stderr=self.subprocess.PIPE)
+
+        start = time.time()
+        while True:
+            try:
+                test_sock = self.socket.socket(self.socket.AF_INET, self.socket.SOCK_STREAM)
+                test_sock.settimeout(0.2)
+                test_sock.connect(("127.0.0.1", self.local_port))
+                test_sock.close()
+                break
+            except Exception:
+                if self._proc is not None and self._proc.poll() is not None:
+                    raise RuntimeError("SSM process exited unexpectedly")
+                if time.time() - start > 10:
+                    raise TimeoutError(f"Timeout waiting for port {self.local_port} to open")
+                time.sleep(0.1)
+
+        return "127.0.0.1", self.local_port
+
+    def teardown(self):
+        if self._proc:
+            self._proc.terminate()
+            self._proc.wait()
+            self._proc = None

{clear_skies_aws-2.0.3 → clear_skies_aws-2.0.5}/src/clearskies_aws/di/aws_additional_config_auto_import.py

@@ -17,7 +17,7 @@ class AwsAdditionalConfigAutoImport(AdditionalConfigAutoImport):
     This DI auto injects boto3, boto3 Session and the parameter store.
     """
 
-    def provide_boto3(self) -> ModuleType:
+    def provide_boto3_sdk(self) -> ModuleType:
         import boto3
 
         return boto3

{clear_skies_aws-2.0.3 → clear_skies_aws-2.0.5}/src/clearskies_aws/di/inject/boto3.py

@@ -12,4 +12,4 @@ class Boto3(Injectable):
     def __get__(self, instance, parent) -> ModuleType:
         if instance is None:
             return self  # type: ignore
-        return self._di.build_from_name("boto3", cache=self.cache)
+        return self._di.build_from_name("boto3_sdk", cache=self.cache)

{clear_skies_aws-2.0.3 → clear_skies_aws-2.0.5}/src/clearskies_aws/endpoints/secrets_manager_rotation.py

@@ -91,7 +91,7 @@ class SecretsManagerRotation(Endpoint):
             pending_secret_data = json.loads(pending_secret["SecretString"])
         except botocore.exceptions.ClientError as error:
             if error.response["Error"]["Code"] == "ResourceNotFoundException":
-                pending_secret_data = None
+                pending_secret_data = {}
             else:
                 raise error