clear-skies-aws 2.0.2__tar.gz → 2.0.4__tar.gz

{clear_skies_aws-2.0.2 → clear_skies_aws-2.0.4}/.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.4/CHANGELOG.md

@@ -0,0 +1,96 @@
+# Changelog
+
+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.4] - 2026-01-09
+
+### Added
+- Add rds mysql cursor
+
+### Changed
+- 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
+
+### Fixed
+- Inverted flag by @cmancone
+- Tooling by @cmancone
+- Mypy by @cmancone
+
+## [2.0.2] - 2025-10-30
+
+### Changed
+- Bump version to v2.0.2 by @github-actions[bot]
+- Update lock file
+
+### Fixed
+- Build path
+- Build path
+
+## [2.0.1] - 2025-10-21
+
+### Added
+- Add simple body routing
+- Add parameter_store tests
+- Add actions
+- Add AwsAdditionalConfigAutoImport
+- Add __init__.py and imports for test module
+- Add parameter_store tests
+- Add actions
+- Add AwsAdditionalConfigAutoImport
+
+### Changed
+- Bump version to v2.0.1 by @github-actions[bot]
+- Disable pytest and mypy for now in [#4](https://github.com/clearskies-py/aws/pull/4)
+- More updates to get to 2.0 in [#1](https://github.com/clearskies-py/aws/pull/1)
+- Moving along by @cmancone
+- Try lambda sqs standard partial batch
+- Combine the v1 / v2 gateway to one
+- Input outputs
+- Use same backend for all
+- Mark failing test as broken
+- More migration work
+- Cleanup/tests by @cmancone
+- Working through basics by @cmancone
+- Moving along by @cmancone
+- Moving along by @cmancone
+- Try lambda sqs standard partial batch
+- Combine the v1 / v2 gateway to one
+- Input outputs
+- Use same backend for all
+- Mark failing test as broken
+- More migration work
+- First commit: Import from WIP by @cmancone
+
+### Fixed
+- Rewrite sqs test
+- Merge in Tom's stuff by @cmancone
+- Rewrite sqs test
+
+### Removed
+- Remove unneeded dependency
+- Remove clearskies_aws.di
+- Remove unneeded dependency
+- Remove clearskies_aws.di
+
+## New Contributors
+* @cmancone made their first contribution
+* @ made their first contribution
+* @github-actions[bot] made their first contribution
+[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
+
+<!-- generated by git-cliff -->

clear_skies_aws-2.0.4/LATEST_CHANGELOG.md

@@ -0,0 +1,11 @@
+## [2.0.4] - 2026-01-09
+
+### Added
+- Add rds mysql cursor
+
+### Changed
+- Use the port forwarder class in [#8](https://github.com/clearskies-py/aws/pull/8)
+
+### Fixed
+- Make age dynamic instead of fixed
+

{clear_skies_aws-2.0.2 → clear_skies_aws-2.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clear-skies-aws
-Version: 2.0.2
+Version: 2.0.4
 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
@@ -16,11 +16,13 @@ Classifier: License :: OSI Approved :: MIT License
 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.2
-Requires-Dist: types-boto3[dynamodb,sns,sqs]<2.0.0,>=1.38.13
+Requires-Dist: clear-skies<3.0.0,>=2.0.20
+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: pymysql<2.0.0,>=1.1.0; 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.2 → clear_skies_aws-2.0.4}/pyproject.toml

@@ -3,14 +3,14 @@
 name = "clear-skies-aws"
 description = "clearskies bindings for working in AWS"
 license = "MIT"
-version = "2.0.2"
+version = "2.0.4"
 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.2,<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 = ['pymysql (>=1.1.0,<2.0.0)']
 
 [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.4/src/clearskies_aws/__init__.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+from clearskies_aws import (
+    actions,
+    backends,
+    contexts,
+    cursors,
+    di,
+    endpoints,
+    handlers,
+    input_outputs,
+    mocks,
+    models,
+    secrets,
+)
+
+__all__ = [
+    "actions",
+    "backends",
+    "contexts",
+    "cursors",
+    "di",
+    "endpoints",
+    "handlers",
+    "input_outputs",
+    "mocks",
+    "models",
+    "secrets",
+]

{clear_skies_aws-2.0.2 → clear_skies_aws-2.0.4}/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.2 → clear_skies_aws-2.0.4}/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.2 → clear_skies_aws-2.0.4}/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.2 → clear_skies_aws-2.0.4}/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.2 → clear_skies_aws-2.0.4}/src/clearskies_aws/contexts/__init__.py

@@ -6,10 +6,10 @@ from clearskies_aws.contexts.lambda_api_gateway import LambdaApiGateway
 from clearskies_aws.contexts.lambda_api_gateway_web_socket import (
     LambdaApiGatewayWebSocket,
 )
-from clearskies_aws.contexts.lambda_invocation import LambdaInvocation
+from clearskies_aws.contexts.lambda_invoke import LambdaInvoke
 from clearskies_aws.contexts.lambda_sns import LambdaSns
-from clearskies_aws.contexts.lambda_sqs_standard_partial_batch import (
-    LambdaSqsStandardPartialBatch,
+from clearskies_aws.contexts.lambda_sqs_standard import (
+    LambdaSqsStandard,
 )
 
 __all__ = [
@@ -17,7 +17,7 @@ __all__ = [
     "LambdaAlb",
     "LambdaApiGateway",
     "LambdaApiGatewayWebSocket",
-    "LambdaInvocation",
+    "LambdaInvoke",
     "LambdaSns",
-    "LambdaSqsStandardPartialBatch",
+    "LambdaSqsStandard",
 ]

{clear_skies_aws-2.0.2 → clear_skies_aws-2.0.4}/src/clearskies_aws/contexts/cli_web_socket_mock.py

@@ -12,8 +12,9 @@ class CliWebSocketMock(cli.Cli):
     The LambdaApiGatewayWebSocket context makes it easy to run websocket applications, but testing
     these locally is literally impossible.  This context provides a close analogue to the way
     the LambdaApiGatewayWebSocket context works to give some testing capabilities when running
-    locally.
+    locally.  It works identically to `clearskies.contexts.Cli` but you have to provide a
+    `connection_id` property in the JSON body.
     """
 
     def __call__(self):
-        return self.execute_application(CliWebSocketMockInputOutput())
+        return self.execute_application(CLIWebSocketMockInputOutput())

{clear_skies_aws-2.0.2 → clear_skies_aws-2.0.4}/src/clearskies_aws/contexts/lambda_alb.py

@@ -65,11 +65,16 @@ class LambdaAlb(Context):
         return application(event, context)
     ```
 
-    ### Context for Callables
+    ### Context Specifics
 
     When using this context, two additional named arguments become available to any callables invoked by clearskies:
-    `event` and `context`.  These correspond to the original `event` and `context` variables provided by AWS to
-    the lambda.
+
+    ```
+    |      Name     |       Type       | Description                      |
+    |:-------------:|:----------------:|----------------------------------|
+    |    `event`    | `dict[str, Any]` | The lambda `event` object        |
+    |   `context`   | `dict[str, Any]` | The lambda `context` object      |
+    ```
     """
 
     def __call__(self, event: dict[str, Any], context: dict[str, Any]) -> Any:  # type: ignore[override]

{clear_skies_aws-2.0.2 → clear_skies_aws-2.0.4}/src/clearskies_aws/contexts/lambda_api_gateway.py

@@ -59,19 +59,23 @@ class LambdaApiGateway(Context):
         return application(event, context)
     ```
 
-    ### Context for Callables
+    ### Context Specifics
 
     When using this context, a number of additional named arguments become available to any callables invoked by
     clearskies:
 
-     1. `event`
-     2. `context`
-     3. `resource`
-     4. `stage`
-     5. `request_id`
-     6. `api_id`
-     7. `api_version` (v1 or v2)
+    ```
+    |      Name     |       Type       | Description                      |
+    |:-------------:|:----------------:|----------------------------------|
+    |   ` event`    | `dict[str, Any]` | The lambda `event` object        |
+    |   `context`   | `dict[str, Any]` | The lambda `context` object      |
+    |   `resource`  |       `str`      | The route resource               |
+    |    `stage`    |       `str`      | The stage of the lambda function |
+    |  `request_id` |       `str`      | The AWS request id for the call  |
+    |    `api_id`   |       `str`      | The id of the API                |
+    | `api_version` |       `str`      | "v1" or "v2"                     |
+    ```
     """
 
-    def __call__(self, event: dict[str, Any], context: dict[str, Any]) -> Any:  # type: ignore[override]
+    def __call__(self, event: dict[str, Any], context: dict[str, Any]) -> dict[str, Any]:  # type: ignore[override]
         return self.execute_application(LambdaApiGatewayInputOutput(event, context))

{clear_skies_aws-2.0.2 → clear_skies_aws-2.0.4}/src/clearskies_aws/contexts/lambda_api_gateway_web_socket.py

@@ -37,7 +37,7 @@ class LambdaApiGatewayWebSocket(Context):
     having to handle such things themselves, since the typical standards of web frameworks won't match up.  In
     the case of routing with an API Gateway, it has its own suggested standard of setting a routekey where the
     API gateway will check for an application-defined route parameter in the request body and use this to route
-    to an appropriate lambda.  With clearskies, you can also use the `clearskies.endpoints.JsonParamEndpointGroup`
+    to an appropriate lambda.  With clearskies, you can also use the `clearskies.endpoints.BodyParameterRouting`
     to accomplish the same.
 
     With a websocket through API Gateway, headers are available during the `on_connect` phase, so you can always
@@ -51,7 +51,29 @@ class LambdaApiGatewayWebSocket(Context):
     there is a base model class in `clearskies_aws.models.WebSocketConnectionModel`.  Check the documentation for
     this class to understand how this is managed and see a "starter" websocket application.
 
+    ### Context Specifics
+
+    The following parameters are made available by name to any function invoked by clearskies when using
+    this context:
+
+    ```
+    |       Name      |       Type       | Description                                      |
+    |:---------------:|:----------------:|--------------------------------------------------|
+    |     `event`     | `dict[str, Any]` | The lambda `event` object                        |
+    |    `context`    | `dict[str, Any]` | The lambda `context` object                      |
+    | `connection_id` |       `str`      | The Connection ID                                |
+    |   `route_key`   |       `str`      | The value of the route key, as determined by AWS |
+    |     `stage`     |       `str`      | The stage of the lambda function                 |
+    |   `request_id`  |       `str`      | The AWS request id for the call                  |
+    |     `api_id`    |       `str`      | The id of the API                                |
+    |  `domain_name`  |       `str`      | The domain name                                  |
+    |   `event_type`  |       `str`      | One of "MESSAGE", "CONNECT", or "DISCONNECT"     |
+    |  `connected_at` |       `str`      | The connection time                              |
+    ```
+
     """
 
-    def __call__(self, event: dict[str, Any], context: dict[str, Any], url: str = "") -> Any:  # type: ignore[override]
+    def __call__(  # type: ignore[override]
+        self, event: dict[str, Any], context: dict[str, Any], url: str = "", request_method: str = ""
+    ) -> dict[str, Any]:
         return self.execute_application(LambdaApiGatewayWebSocketInputOutput(event, context, url))

clear_skies_aws-2.0.4/src/clearskies_aws/contexts/lambda_invoke.py

@@ -0,0 +1,138 @@
+from __future__ import annotations
+
+from typing import Any
+
+from clearskies.authentication import Public
+from clearskies.contexts.context import Context
+
+from clearskies_aws.input_outputs import LambdaInvoke as LambdaInvokeInputOutput
+
+
+class LambdaInvoke(Context):
+    """
+    Execute a lambda directly.
+
+    This context is used when your clearskies application is running in a lambda that is executed
+    directly by some variation of `aws lambda invoke`.  For this context, the `event` object passed
+    to the lambda handler becomes the request body in the clearskies application.  Note that, unlike
+    other lambda execution strategies (ALB, Api Gateway, etc...) the event object is exactly equal
+    to the body sent in with the lambda function.
+
+    ### Usage
+
+    Here's a simple example:
+
+    ```
+    import clearskies
+
+
+    def my_function(request_data):
+        return request_data
+
+
+    lambda_invoke = clearskies_aws.contexts.LambdaInvoke(
+        clearskies.endpoints.Callable(
+            my_function,
+            return_standard_response=False,
+        )
+    )
+
+
+    def lambda_handler(event, context):
+        return lambda_invoke(event, context)
+    ```
+
+    You can attach this to a lambda and might invoke it like so, with the following response:
+
+    ```
+    $ aws lambda invoke --function-name [function_name] --cli-binary-format raw-in-base64-out --payload '{"some":"data"}' | jq
+    { "Payload": {"some": "data"} }
+    ```
+
+    Invoking a lambda doesn't happen from an http context, so there is no URL/request method/headers/etc.
+    This typically means that clearskies applications in this context don't do routing and don't have
+    authentication configured.  If you wanted to though, you could use `clearskies.endpoints.BodyParameterRouting`
+    to setup some basic routing and let the invoking client choose a route by providing a parameter in the
+    payload passed to lambda invoke.
+
+    You can pass a URL/request method into the context when you invoke it, which is often used to simplify
+    configuration: you can setup a standard clearskies applications with multiple endpoints, and then
+    use that one application in multiple lambdas, specifying which endpoint to call for each lambda.
+    This can also be helpful if you already have a clearskies application prepared for a standard http context
+    and want to execute some subset of those endpoints in a lambda invoke context.  It looks something like this:
+
+    ```
+    import clearskies
+
+
+    def some_function(request_data):
+        return request_data
+
+
+    def some_other_function(request_data):
+        return request_data
+
+
+    def something_else(request_data):
+        return request_data
+
+
+    lambda_invoke = clearskies_aws.contexts.LambdaInvoke(
+        clearskies.endpoints.EndpointGroup(
+            [
+                clearskies.endpoints.Callable(
+                    some_function,
+                    url="some_function",
+                ),
+                clearskies.endpoints.Callable(
+                    some_other_function,
+                    url="some_other_function",
+                ),
+                clearskies.endpoints.Callable(
+                    something_else,
+                    url="something_else",
+                ),
+            ]
+        )
+    )
+
+
+    def some_function_handler(event, context):
+        return lambda_invoke(event, context, url="some_function")
+
+
+    def some_other_function_handler(event, context):
+        return lambda_invoke(event, context, url="some_other_function")
+
+
+    def something_else_handler(event, context):
+        return lambda_invoke(event, context, url="something_else")
+    ```
+
+    ### Context Specifics
+
+    When using the lambda_invoke context, it exposes a few context specific parameters which can be injected into
+    any function called by clearskies:
+
+    |       Name         |        Type      |           Description           |
+    |:------------------:|:----------------:|:-------------------------------:|
+    |       `event`      | `dict[str, Any]` | The lambda `event` object       |
+    |      `context`     | `dict[str, Any]` | The lambda `context` object     |
+    |  `invocation_type` |      `str`       |        Always `"direct"`        |
+    |   `function_name`  |      `str`       | The name of the lambda function |
+    | `function_version` |      `str`       |       The function version      |
+    |    `request_id`    |      `str`       | The AWS request id for the call |
+
+    """
+
+    def __call__(  # type: ignore[override]
+        self, event: dict[str, Any], context: dict[str, Any], request_method: str = "", url: str = ""
+    ) -> dict[str, Any]:
+        return self.execute_application(
+            LambdaInvokeInputOutput(
+                event,
+                context,
+                request_method=request_method,
+                url=url,
+            )
+        )

clear_skies_aws-2.0.4/src/clearskies_aws/contexts/lambda_sns.py

@@ -0,0 +1,124 @@
+from __future__ import annotations
+
+from typing import Any
+
+from clearskies.authentication import Public
+from clearskies.contexts.context import Context
+
+from clearskies_aws.input_outputs import LambdaSns as LambdaSnsInputOutput
+
+
+class LambdaSns(Context):
+    """
+    Execute a clearskies application when attached to a lambda triggered by SNS.
+
+    This one is very straight-forward: just attach your clearskies application to work with an
+    SNS-triggered lambda.  `request_data` provided to the clearskies application will be the
+    message sent to the SNS.  Since this is no longer an http context, the various http parameters
+    (url, request method, headers, and even responses) do not exist.  Routing won't exist unless
+    you use `clearskies.endpoints.BodyParameterRouting` and include the route parameter in your
+    SNS message body.
+
+    ### Usage
+
+    Here's a simple example:
+
+    ```
+    import clearskies
+
+
+    def my_function(request_data):
+        print(request_data)
+
+
+    lambda_invoke = clearskies_aws.contexts.LambdaInvoke(
+        clearskies.endpoints.Callable(
+            my_function,
+            return_standard_response=False,
+        )
+    )
+
+
+    def lambda_handler(event, context):
+        return lambda_invoke(event, context)
+    ```
+
+    Note the lack of a return value.  You can return a value if you want, but it will be ignored
+    because SNS has no concept of a return response.
+
+    If you have a number of Lambda/SNS handlers, you can bundle them together for ease-of-management
+    and specify the URL when you invoke them:
+
+    ```
+    import clearskies
+
+
+    def some_function(request_data):
+        return request_data
+
+
+    def some_other_function(request_data):
+        return request_data
+
+
+    def something_else(request_data):
+        return request_data
+
+
+    lambda_invoke = clearskies_aws.contexts.LambdaSns(
+        clearskies.endpoints.EndpointGroup(
+            [
+                clearskies.endpoints.Callable(
+                    some_function,
+                    url="some_function",
+                ),
+                clearskies.endpoints.Callable(
+                    some_other_function,
+                    url="some_other_function",
+                ),
+                clearskies.endpoints.Callable(
+                    something_else,
+                    url="something_else",
+                ),
+            ]
+        )
+    )
+
+
+    def some_function_handler(event, context):
+        return lambda_invoke(event, context, url="some_function")
+
+
+    def some_other_function_handler(event, context):
+        return lambda_invoke(event, context, url="some_other_function")
+
+
+    def something_else_handler(event, context):
+        return lambda_invoke(event, context, url="something_else")
+    ```
+
+    ### Context Specifics
+
+    When you use the LambdaSns context, it makes the following named parameters available
+    to any callable that is invoked by clearskies:
+
+    ```
+    |    Name      |      Type        | Description                                    |
+    |:------------:|:----------------:|------------------------------------------------|
+    |    `event`   | `dict[str, Any]` | The lambda `event` object                      |
+    |   `context`  | `dict[str, Any]` | The lambda `context` object                    |
+    | `message_id` |       `str`      | The AWS message id                             |
+    |  `topic_arn` |       `str`      | The ARN of the SNS topic that sent the message |
+    |   `subject`  |       `str`      | Any subject attached to the SNS message        |
+    |  `timestamp` |       `str`      | The timestamp when the message was sent        |
+    ```
+    """
+
+    def __call__(self, event: dict[str, Any], context: dict[str, Any], request_method: str = "", url: str = ""):  # type: ignore[override]
+        try:
+            return self.execute_application(
+                LambdaSnsInputOutput(event, context, request_method=request_method, url=url)
+            )
+        except Exception as e:
+            print("Failed message " + event["Records"][0]["Sns"]["MessageId"] + ". Error error: " + str(e))
+            raise e