clear-skies-aws 2.0.11__tar.gz → 2.0.12__tar.gz

{clear_skies_aws-2.0.11 → clear_skies_aws-2.0.12}/.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: v0.0.34
+_commit: v0.0.45
 _src_path: https://github.com/clearskies-py/clearskies-module-template
 author_email: tom.nijboer@cimpress.com
 author_name: Tom Nijboer

{clear_skies_aws-2.0.11 → clear_skies_aws-2.0.12}/.github/workflows/run-tests.yml

@@ -67,8 +67,8 @@ jobs:
       python-version: ${{ matrix.python-version }}
       run-mypy: ${{ needs.changes.outputs.tests == 'true' }}
       run-pytest: ${{ needs.changes.outputs.tests == 'true' }}
-      run-ruff-check: ${{ needs.changes.outputs.tests == 'true' }}
       run-ruff-format: ${{ needs.changes.outputs.tests == 'true' }}
+      run-ruff-check: ${{ needs.changes.outputs.tests == 'true' }}
     secrets: inherit
     strategy:
       matrix:
@@ -76,6 +76,7 @@ jobs:
           - '3.11'
           - '3.12'
           - '3.13'
+          - '3.14'
       fail-fast: false
 
   status:

{clear_skies_aws-2.0.11 → clear_skies_aws-2.0.12}/.github/workflows/tests-matrix.yaml

@@ -14,10 +14,10 @@ on:
       run-pytest:
         required: true
         type: boolean
-      run-ruff-check:
+      run-ruff-format:
         required: true
         type: boolean
-      run-ruff-format:
+      run-ruff-check:
         required: true
         type: boolean
 
@@ -46,7 +46,6 @@ jobs:
       - name: Install dependencies
         run: uv sync --locked --all-extras --dev
       - run: uv run mypy src --check || true
-        continue-on-error: true
 
   pytest:
     name: pytest
@@ -64,26 +63,23 @@ jobs:
           enable-cache: true
       - name: Install dependencies
         run: uv sync --locked --all-extras --dev
-      - run: uv run pytest -v
-        continue-on-error: true
-      - run: git diff --exit-code --stat
-        continue-on-error: true
-
+      - run: uv run pytest -v . -m "not broken"
+      - run: git diff --exit-code --stat HEAD
 
-  ruff-check:
-    name: ruff-check
+  ruff-format:
+    name: ruff-format
     runs-on: ${{ inputs.runner }}
-    if: inputs.run-ruff-check
+    if: inputs.run-ruff-format
     steps:
       - uses: astral-sh/ruff-action@v3
         with:
-          args: "check --diff"
+          args: "format --diff"
 
-  ruff-format:
-    name: ruff-format
+  ruff-check:
+    name: ruff-check
     runs-on: ${{ inputs.runner }}
-    if: inputs.run-ruff-format
+    if: inputs.run-ruff-check
     steps:
       - uses: astral-sh/ruff-action@v3
         with:
-          args: "format --diff"
+          args: "check --diff"

{clear_skies_aws-2.0.11 → clear_skies_aws-2.0.12}/.pre-commit-config.yaml

@@ -1,5 +1,5 @@
-# Pre-commit configuration for  Akeyless Custom Producer
-fail_fast: true
+# Pre-commit configuration for Clearkskies AWS project
+fail_fast: false
 
 ci:
     autofix_commit_msg: "chore(pre-commit): autofix run"
@@ -8,6 +8,9 @@ ci:
 default_install_hook_types:
     - pre-commit
     - commit-msg
+    - post-checkout
+    - post-merge
+    - post-rewrite
 
 default_stages: ["pre-commit"]
 

clear_skies_aws-2.0.12/.vscode/settings.json

@@ -0,0 +1,21 @@
+{
+    "python.testing.pytestArgs": ["tests"],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
+    "ruff.interpreter": ["${workspaceFolder}/.venv/bin/python"],
+    "ruff.path": ["${workspaceFolder}/.venv/bin/ruff"],
+    "ruff.configuration": "${workspaceFolder}/ruff.toml",
+    "ruff.nativeServer": "on",
+    "[python]": {
+        "editor.formatOnSave": true,
+        "editor.codeActionsOnSave": {
+            "source.fixAll": "explicit",
+            "source.organizeImports": "explicit"
+        },
+        "editor.defaultFormatter": "charliermarsh.ruff"
+    },
+    "mypy-type-checker.args": [
+        "--config-file=${workspaceFolder}/pyproject.toml"
+    ]
+}

{clear_skies_aws-2.0.11 → clear_skies_aws-2.0.12}/CHANGELOG.md

@@ -5,8 +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.12] - 2026-01-27
+
+### Added
+- Add docs
+- Add stepfucntions context with variables to ENV vars
+
+### Changed
+- Merge pull request #11 from clearskies-py/stepfunctions-variables by @cmancone in [#11](https://github.com/clearskies-py/aws/pull/11)
+- Update docstrings of stepfunctions
+- Move Environment to the input output of step functions
+- Udpate to QueryResult
+- Update to latest copier template
+
+### Fixed
+- Ignore dynamodb mypy issues
+
 ## [2.0.11] - 2026-01-21
 
+### Changed
+- Bump version to v2.0.11 by @github-actions[bot]
+
 ### Fixed
 - Set correct type for context
 
@@ -147,6 +166,7 @@ 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.12]: https://github.com/clearskies-py/aws/compare/v2.0.11..v2.0.12
 [2.0.11]: https://github.com/clearskies-py/aws/compare/v2.0.10..v2.0.11
 [2.0.10]: https://github.com/clearskies-py/aws/compare/v2.0.9..v2.0.10
 [2.0.9]: https://github.com/clearskies-py/aws/compare/v2.0.8..v2.0.9

clear_skies_aws-2.0.12/LATEST_CHANGELOG.md

@@ -0,0 +1,16 @@
+## [2.0.12] - 2026-01-27
+
+### Added
+- Add docs
+- Add stepfucntions context with variables to ENV vars
+
+### Changed
+- Merge pull request #11 from clearskies-py/stepfunctions-variables by @cmancone in [#11](https://github.com/clearskies-py/aws/pull/11)
+- Update docstrings of stepfunctions
+- Move Environment to the input output of step functions
+- Udpate to QueryResult
+- Update to latest copier template
+
+### Fixed
+- Ignore dynamodb mypy issues
+

{clear_skies_aws-2.0.11 → clear_skies_aws-2.0.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clear-skies-aws
-Version: 2.0.11
+Version: 2.0.12
 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,7 +17,7 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: <4.0,>=3.11
 Requires-Dist: awslambdaric>=3.1.1
 Requires-Dist: boto3<2.0.0,>=1.26.148
-Requires-Dist: clear-skies<3.0.0,>=2.0.20
+Requires-Dist: clear-skies<3.0.0,>=2.0.37
 Requires-Dist: jinja2>=3.1.6
 Requires-Dist: types-boto3[dynamodb,secretsmanager,ses,sns,sqs,ssm,stepfunctions]<2.0.0,>=1.38.13
 Provides-Extra: akeyless

{clear_skies_aws-2.0.11 → clear_skies_aws-2.0.12}/pyproject.toml

@@ -3,14 +3,14 @@
 name = "clear-skies-aws"
 description = "clearskies bindings for working in AWS"
 license = "MIT"
-version = "2.0.11"
+version = "2.0.12"
 readme = "./README.md"
 authors = [{name = "tnijboer"}, {name = "Conor Mancone", email = "cmancone@gmail.com"}]
 requires-python = '>=3.11,<4.0'
 dependencies = [
     "awslambdaric>=3.1.1",
     'boto3 (>=1.26.148,<2.0.0)',
-    "clear-skies>=2.0.20,<3.0.0",
+    "clear-skies>=2.0.37,<3.0.0",
     "jinja2>=3.1.6",
     'types-boto3[dynamodb,sns,sqs,ses,ssm,secretsmanager,stepfunctions] (>=1.38.13,<2.0.0)',
 ]

{clear_skies_aws-2.0.11 → clear_skies_aws-2.0.12}/src/clearskies_aws/backends/backend.py

@@ -7,6 +7,12 @@ import clearskies.model
 import clearskies.query
 from clearskies.autodoc.schema import Schema as AutoDocSchema
 from clearskies.di import inject
+from clearskies.query.result import (
+    CountQueryResult,
+    RecordQueryResult,
+    RecordsQueryResult,
+    SuccessQueryResult,
+)
 
 from clearskies_aws.di.inject import boto3
 
@@ -31,35 +37,25 @@ class Backend(clearskies.Configurable, clearskies.backends.Backend, clearskies.d
     boto3 = boto3.Boto3()
     environment = inject.Environment()
 
-    def update(self, id: int | str, data: dict[str, Any], model: clearskies.model.Model) -> dict[str, Any]:
+    def update(self, id: int | str, data: dict[str, Any], model: clearskies.model.Model) -> RecordQueryResult:
         """Update the record with the given id with the information from the data dictionary."""
-        return {}
+        return RecordQueryResult(record={})
 
-    def create(self, data: dict[str, Any], model: clearskies.model.Model) -> dict[str, Any]:
+    def create(self, data: dict[str, Any], model: clearskies.model.Model) -> RecordQueryResult:
         """Create a record with the information from the data dictionary."""
-        return {}
+        return RecordQueryResult(record={})
 
-    def delete(self, id: int | str, model: clearskies.model.Model) -> bool:
+    def delete(self, id: int | str, model: clearskies.model.Model) -> SuccessQueryResult:
         """Delete the record with the given id."""
-        return True
+        return SuccessQueryResult()
 
-    def count(self, query: clearskies.query.Query) -> int:
+    def count(self, query: clearskies.query.Query) -> CountQueryResult:
         """Return the number of records which match the given query configuration."""
-        return 1
-
-    def records(
-        self,
-        query: clearskies.query.Query,
-        next_page_data: dict[str, str | int] | None = None,
-    ) -> list[dict[str, Any]]:
-        """
-        Return a list of records that match the given query configuration.
+        return CountQueryResult(count=1)
 
-        next_page_data is used to return data to the caller.  Pass in an empty dictionary, and it will be populated
-        with the data needed to return the next page of results.  If it is still an empty dictionary when returned,
-        then there is no additional data.
-        """
-        return []
+    def records(self, query: clearskies.query.Query) -> RecordsQueryResult:
+        """Return a list of records that match the given query configuration."""
+        return RecordsQueryResult(records=[])
 
     def validate_pagination_data(self, data: dict[str, Any], case_mapping: Callable[[str], str]) -> str:
         """

{clear_skies_aws-2.0.11 → clear_skies_aws-2.0.12}/src/clearskies_aws/backends/sqs_backend.py

@@ -5,6 +5,7 @@ from typing import Any
 
 from clearskies import Model
 from clearskies.query import Query
+from clearskies.query.result import CountQueryResult, RecordQueryResult, RecordsQueryResult, SuccessQueryResult
 from types_boto3_sqs import SQSClient
 
 from clearskies_aws.backends import backend
@@ -37,25 +38,21 @@ class SqsBackend(backend.Backend):
 
         return self._sqs
 
-    def create(self, data: dict[str, Any], model: Model) -> dict[str, Any]:
+    def create(self, data: dict[str, Any], model: Model) -> RecordQueryResult:
         self.sqs.send_message(
             QueueUrl=model.destination_name(),
             MessageBody=json.dumps(data),
         )
-        return {**data}
+        return RecordQueryResult(record={**data})
 
-    def update(self, id: int | str, data: dict[str, Any], model: Model) -> dict[str, Any]:
+    def update(self, id: int | str, data: dict[str, Any], model: Model) -> RecordQueryResult:
         raise ValueError("The SQS backend only supports the create operation")
 
-    def delete(self, id: int | str, model: Model) -> bool:
+    def delete(self, id: int | str, model: Model) -> SuccessQueryResult:
         raise ValueError("The SQS backend only supports the create operation")
 
-    def count(self, query: Query) -> int:
+    def count(self, query: Query) -> CountQueryResult:
         raise ValueError("The SQS backend only supports the create operation")
 
-    def records(
-        self,
-        query: Query,
-        next_page_data: dict[str, str | int] | None = None,
-    ) -> list[dict[str, Any]]:
+    def records(self, query: Query) -> RecordsQueryResult:
         raise ValueError("The SQS backend only supports the create operation")

{clear_skies_aws-2.0.11 → clear_skies_aws-2.0.12}/src/clearskies_aws/contexts/__init__.py

@@ -11,6 +11,7 @@ from clearskies_aws.contexts.lambda_sns import LambdaSns
 from clearskies_aws.contexts.lambda_sqs_standard import (
     LambdaSqsStandard,
 )
+from clearskies_aws.contexts.lambda_step_function import LambdaStepFunction
 
 __all__ = [
     "CliWebSocketMock",
@@ -20,4 +21,5 @@ __all__ = [
     "LambdaInvoke",
     "LambdaSns",
     "LambdaSqsStandard",
+    "LambdaStepFunction",
 ]

clear_skies_aws-2.0.12/src/clearskies_aws/contexts/lambda_step_function.py

@@ -0,0 +1,129 @@
+from __future__ import annotations
+
+from typing import Any, Callable
+
+from clearskies.contexts.context import Context
+
+from clearskies_aws.input_outputs.lambda_step_function import LambdaStepFunction as LambdaStepFunctionInputOutput
+
+
+class LambdaStepFunction(Context):
+    """
+    Execute a Lambda invoked from AWS Step Functions.
+
+    This context is used when your clearskies application is running in a Lambda that is
+    invoked from an AWS Step Functions state machine. It supports extracting variables
+    assigned in the Step Functions state and exposing them through the clearskies
+    Environment class.
+
+    ### Usage
+
+    Basic usage:
+
+    ```python
+    import clearskies
+    import clearskies_aws
+
+
+    def my_function(request_data, environment):
+        # Access extracted environment variables
+        business_name = environment.get("BUSINESS_NAME")
+        return {"business": business_name, "data": request_data}
+
+
+    lambda_step_function = clearskies_aws.contexts.LambdaStepFunction(
+        clearskies.endpoints.Callable(
+            my_function,
+            return_standard_response=False,
+        ),
+        environment_keys=["BUSINESS_NAME", "GITLAB_AUTH_KEY"],
+    )
+
+
+    def lambda_handler(event, context):
+        return lambda_step_function(event, context)
+    ```
+
+    ### Configuration Options
+
+    The `environment_keys` parameter accepts three types:
+
+    **1. List of keys** - Extract specific keys from the event:
+    ```python
+    clearskies_aws.contexts.LambdaStepFunction(
+        endpoint, environment_keys=["BUSINESS_NAME", "GITLAB_AUTH_KEY"]
+    )
+    ```
+
+    **2. Mapping dict** - Map event keys to environment variable names:
+    ```python
+    clearskies_aws.contexts.LambdaStepFunction(
+        endpoint,
+        environment_keys={
+            "BUSINESS_NAME": "BUSINESS_NAME",  # same name
+            "GITLAB_AUTH_KEY": "GITLAB_TOKEN_PATH",  # rename
+        },
+    )
+    ```
+
+    **3. Callable** - Full control via a function (supports dependency injection):
+    ```python
+    def extract_env_vars(event, secrets):
+        # Can inject clearskies dependencies like secrets
+        return {
+            "BUSINESS_NAME": event.get("BUSINESS_NAME"),
+            "GITLAB_KEY": secrets.get(event.get("GITLAB_AUTH_KEY")),
+        }
+
+
+    clearskies_aws.contexts.LambdaStepFunction(endpoint, environment_keys=extract_env_vars)
+    ```
+
+    ### Context Specifics
+
+    When using this context, the following named parameters become available to inject
+    into any callable invoked 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 `"step-functions"`            |
+    |    `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      |
+    |    `states_context`    |  `dict[str, Any]`  | The Step Functions $states context   |
+
+    """
+
+    def __init__(
+        self,
+        endpoint,
+        environment_keys: list[str] | dict[str, str] | Callable[..., dict[str, Any]] | None = None,
+        **kwargs,
+    ):
+        super().__init__(endpoint, **kwargs)
+        self._environment_keys = environment_keys
+
+    def __call__(  # type: ignore[override]
+        self,
+        event: dict[str, Any],
+        context: dict[str, Any],
+        request_method: str = "",
+        url: str = "",
+    ) -> dict[str, Any]:
+        input_output = LambdaStepFunctionInputOutput(
+            event,
+            context,
+            request_method=request_method,
+            url=url,
+            environment_keys=self._environment_keys,
+        )
+
+        # Inject extra environment variables from the step function event
+        input_output.inject_extra_environment_variables(
+            self.di.build("environment", cache=True),
+            self.di,
+        )
+
+        return self.execute_application(input_output)

{clear_skies_aws-2.0.11 → clear_skies_aws-2.0.12}/src/clearskies_aws/input_outputs/__init__.py

@@ -9,6 +9,7 @@ from clearskies_aws.input_outputs.lambda_api_gateway_web_socket import (
 from clearskies_aws.input_outputs.lambda_invoke import LambdaInvoke
 from clearskies_aws.input_outputs.lambda_sns import LambdaSns
 from clearskies_aws.input_outputs.lambda_sqs_standard import LambdaSqsStandard
+from clearskies_aws.input_outputs.lambda_step_function import LambdaStepFunction
 
 __all__ = [
     "CliWebSocketMock",
@@ -18,4 +19,5 @@ __all__ = [
     "LambdaInvoke",
     "LambdaSns",
     "LambdaSqsStandard",
+    "LambdaStepFunction",
 ]