localstack-sdk-python 0.0.3__tar.gz → 4.3.0__tar.gz

localstack_sdk_python-4.3.0/.github/workflows/release.yml

@@ -0,0 +1,133 @@
+name: Release LocalStack Python Client
+
+on:
+  repository_dispatch:
+    types: [release-sdk]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: The version of the OpenAPI spec to release the client for
+        required: true
+
+env:
+  git_user_name: localstack[bot]
+  git_user_email: localstack-bot@users.noreply.github.com
+
+jobs:
+
+  test_python:
+    runs-on: ubuntu-latest
+    env:
+      release: ${{ github.event_name == 'workflow_dispatch' && inputs.version || github.event.client_payload.version}}
+
+    steps:
+    - name: "Pull image"
+      run: |
+        docker pull localstack/localstack-pro:${{ env.release }}
+
+    - name: "Checkout"
+      uses: actions/checkout@v4
+      with:
+        # setuptools_scm requires git history to determine the version
+        fetch-depth: 0
+
+    - name: "Set up Python 3.11"
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+
+    - name: "Install uv"
+      uses: astral-sh/setup-uv@v3
+
+    - name: "Generate code from spec"
+      run: |
+        make clean-generated
+        ./bin/generate.sh ${{ env.release }}
+
+    - name: "Prepare git config"
+      run: |
+        git config user.name ${{ env.git_user_name }}
+        git config user.email ${{ env.git_user_email }}
+
+    - name: "Commit changed code"
+      run: |
+        # Code automatically generated goes into the packages directory.
+        # As we generate code for the version to be released, we commit those changes.
+        if git status --porcelain packages/ | grep -q '^'; then
+          git add packages/
+          git commit -m "Generate code for ${{ env.release }}"
+
+          echo "Changes committed successfully"
+        else
+          echo "No changes detected after generating the code"
+        fi
+
+    - name: "Install project"
+      run: |
+        make install-dev
+
+    - name: "Install LocalStack"
+      run: |
+        pip install localstack==${{ env.release }}
+
+    - name: "Start Localstack"
+      env:
+       LOCALSTACK_AUTH_TOKEN: ${{ secrets.LOCALSTACK_AUTH_TOKEN }}
+      run: |
+          source .venv/bin/activate
+          DEBUG=1 DISABLE_EVENTS="1" IMAGE_NAME="localstack/localstack-pro:${{ env.release }}" localstack start -d
+          localstack wait -t 120 || (python -m localstack.cli.main logs && false)
+
+    - name: "Run Python Tests"
+      env:
+        LOCALSTACK_AUTH_TOKEN: ${{ secrets.LOCALSTACK_AUTH_TOKEN }}
+      run: |
+        make test
+
+    - name: "Stop Localstack"
+      if: success() || failure()
+      run: |
+          source .venv/bin/activate
+          localstack logs
+          localstack stop
+
+    - name: "Install release helper"
+      run: |
+        curl -o bin/release-helper.sh -L https://api.github.com/repos/localstack/localstack/contents/bin/release-helper.sh -H 'Accept: application/vnd.github.v3.raw'
+        chmod +x bin/release-helper.sh
+
+    - name: "Create the release commit and tag"
+      run: |
+        bin/release-helper.sh git-commit-release ${{ env.release }}
+
+    - name: "Publish release to pypi"
+      env:
+        UV_PUBLISH_TOKEN: ${{ secrets.UV_PUBLISH_TOKEN }}
+      run: |
+        make install publish
+
+    - name: "Push the release commit and tag"
+      run: |
+        git push --follow-tags
+
+    - name: "Create GitHub release"
+      env:
+        GITHUB_TOKEN: ${{ secrets.LOCALSTACK_GITHUB_TOKEN }}
+      run: gh release create "${{ env.release }}" --generate-notes --draft
+
+    - name: "Commit and push next development version"
+      run: |
+        bin/release-helper.sh git-commit-increment
+        git push
+
+    - name: "Publish development version to pypi"
+      env:
+        UV_PUBLISH_TOKEN: ${{ secrets.UV_PUBLISH_TOKEN }}
+      run: |
+        make install publish
+
+    - name: "Show git modifications"
+      run: |
+        git log --oneline -n 4
+        git show HEAD~1
+        git show HEAD

{localstack_sdk_python-0.0.3 → localstack_sdk_python-4.3.0}/.gitignore

@@ -63,4 +63,10 @@ localstack-pro-azure/tests/otherlangs/dotnet/*/obj
 
 # setuptools_scm version.py
 */*/*/*/version.py
-localstack-sdk-python-2/.openapi-generator/
+localstack-sdk-python-2/.openapi-generator/
+
+# setuptools_scm version.py
+**/version.py
+
+# release helper
+bin/release-helper.sh

{localstack_sdk_python-0.0.3 → localstack_sdk_python-4.3.0}/Makefile

@@ -1,29 +1,37 @@
-VENV_CMD ?= python3 -m venv
 VENV_DIR ?= .venv
-VENV_BIN = python3 -m venv
 VENV_RUN = . $(VENV_DIR)/bin/activate
 VENV_ACTIVATE = $(VENV_DIR)/bin/activate
 TEST_PATH ?= .
 TEST_EXEC ?= python -m
 PYTEST_LOGLEVEL ?= warning
-PIP_CMD ?= pip
 
 install:			## omit dev dependencies
+	uv venv
 	uv sync --no-dev
 
 install-dev:		## create the venv and install
+	uv venv
 	uv sync
 
-build-spec:			## build the entire localstack api spec (openapi.yaml in the root folder)
-	$(VENV_RUN); python scripts/create_spec.py
-
 clean:         		## Clean up the virtual environment
 	rm -rf $(VENV_DIR)
 	rm -rf dist/
 
+clean-dist:
+	rm -rf dist/
+
 clean-generated:	## Cleanup generated code
 	rm -rf packages/localstack-sdk-generated/localstack/
 
+generate:			## Generate the code from the OpenAPI specs
+	./bin/generate.sh
+
+build:
+	uv build --all-packages
+
+publish: clean-dist build
+	uv publish
+
 format:
 	($(VENV_RUN); python -m ruff format --exclude packages .; python -m ruff check --output-format=full --exclude packages --fix .)
 
@@ -33,4 +41,4 @@ lint:
 test:              		  ## Run automated tests
 	($(VENV_RUN); $(TEST_EXEC) pytest --durations=10 --log-cli-level=$(PYTEST_LOGLEVEL) $(PYTEST_ARGS) $(TEST_PATH))
 
-.PHONY: clean install install-dev
+.PHONY: clean install install-dev clean clean-dist clean-generated generate build publish format lint test

localstack_sdk_python-4.3.0/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: localstack-sdk-python
+Version: 4.3.0
+Summary: Python SDK for LocalStack
+Author-email: LocalStack Team <info@localstack.cloud>
+Project-URL: Homepage, https://localstack.cloud
+Project-URL: Documentation, https://docs.localstack.cloud
+Project-URL: Repository, https://github.com/localstack/localstack-sdk-python.git
+Project-URL: Issues, https://github.com/localstack/localstack-sdk-python/issues
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: localstack-sdk-generated
+Dynamic: license-file
+
+# LocalStack Python SDK
+[![PyPI version](https://img.shields.io/pypi/v/localstack-sdk-python)](https://pypi.org/project/localstack-sdk-python/)
+[![Integration Tests](https://github.com/localstack/localstack-sdk-python/actions/workflows/test.yml/badge.svg)](https://github.com/localstack/localstack-sdk-python/actions/workflows/test.yml)
+
+This is the Python SDK for LocalStack.
+LocalStack offers a number of developer endpoints (see [docs](https://docs.localstack.cloud/references/internal-endpoints/)).
+This SDK provides a programmatic and easy way to interact with them.
+
+> [!WARNING]
+> This project is still in a preview phase and will be subject to fast and breaking changes.
+
+### Project Structure
+
+This project is composed by two Python packages:
+
+- `packages/localstack-sdk-generated`: generated from the LocalStack's OpenAPI specs with [openapi-generator](https://github.com/OpenAPITools/openapi-generator).
+The LocalStack's OpenAPI specs are available in [localstack/openapi](https://github.com/localstack/openapi).
+This package is not meant to be manually modified, as it needs to be generated every time from the specs.
+- `localstack-sdk-python`: the user-facing SDK that consumed `localstack-sdk-generated` as its main dependency.
+
+### Installation
+
+You can install the LocalStack Python SDK with `pip`:
+
+```shell
+pip install localstack-sdk-python
+```
+
+#### From Source
+
+This project uses [uv](https://github.com/astral-sh/uv) as a package manager.
+On a Unix system, you can install `uv` with the standalone installer:
+
+```shell
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+Once `uv` is installed, you can install the project from source with:
+
+```shell
+make install
+```
+
+To run the integration test suite:
+
+```shell
+make test
+```
+
+Note that LocalStack Pro (with the same version as the SDK) should be running in the background to execute the test.
+
+### Quickstart
+
+To get started with our SDK, check out the [official documentation on https://docs.localstack.cloud](https://docs.localstack.cloud/user-guide/tools/localstack-sdk/python/). 
+You'll find comprehensive guides and detailed code samples that demonstrate how to use the various features provided
+by the SDK.

localstack_sdk_python-4.3.0/README.md

@@ -0,0 +1,56 @@
+# LocalStack Python SDK
+[![PyPI version](https://img.shields.io/pypi/v/localstack-sdk-python)](https://pypi.org/project/localstack-sdk-python/)
+[![Integration Tests](https://github.com/localstack/localstack-sdk-python/actions/workflows/test.yml/badge.svg)](https://github.com/localstack/localstack-sdk-python/actions/workflows/test.yml)
+
+This is the Python SDK for LocalStack.
+LocalStack offers a number of developer endpoints (see [docs](https://docs.localstack.cloud/references/internal-endpoints/)).
+This SDK provides a programmatic and easy way to interact with them.
+
+> [!WARNING]
+> This project is still in a preview phase and will be subject to fast and breaking changes.
+
+### Project Structure
+
+This project is composed by two Python packages:
+
+- `packages/localstack-sdk-generated`: generated from the LocalStack's OpenAPI specs with [openapi-generator](https://github.com/OpenAPITools/openapi-generator).
+The LocalStack's OpenAPI specs are available in [localstack/openapi](https://github.com/localstack/openapi).
+This package is not meant to be manually modified, as it needs to be generated every time from the specs.
+- `localstack-sdk-python`: the user-facing SDK that consumed `localstack-sdk-generated` as its main dependency.
+
+### Installation
+
+You can install the LocalStack Python SDK with `pip`:
+
+```shell
+pip install localstack-sdk-python
+```
+
+#### From Source
+
+This project uses [uv](https://github.com/astral-sh/uv) as a package manager.
+On a Unix system, you can install `uv` with the standalone installer:
+
+```shell
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+Once `uv` is installed, you can install the project from source with:
+
+```shell
+make install
+```
+
+To run the integration test suite:
+
+```shell
+make test
+```
+
+Note that LocalStack Pro (with the same version as the SDK) should be running in the background to execute the test.
+
+### Quickstart
+
+To get started with our SDK, check out the [official documentation on https://docs.localstack.cloud](https://docs.localstack.cloud/user-guide/tools/localstack-sdk/python/). 
+You'll find comprehensive guides and detailed code samples that demonstrate how to use the various features provided
+by the SDK.

localstack_sdk_python-4.3.0/bin/generate.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+# Use the latest spec by default
+SPEC_URL="https://raw.githubusercontent.com/localstack/openapi/refs/heads/main/openapi/emulators/localstack-spec-latest.yml"
+
+if [ -n "$1" ]; then
+  SPEC_URL="https://github.com/localstack/openapi/releases/download/v$1/localstack-spec.yml"
+fi
+
+# Check if the URL is valid
+if ! wget --spider -q "$SPEC_URL"; then
+    echo "Spec URL seems not accessible: $SPEC_URL"
+    exit 1
+fi
+
+docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli:v7.10.0 generate \
+    -i "$SPEC_URL" \
+    --skip-validate-spec \
+    -g python \
+    -o /local//packages/localstack-sdk-generated \
+    --global-property models,apis,supportingFiles \
+    -p packageName=localstack.sdk \
+    --template-dir /local/packages/localstack-sdk-generated/templates \
+    --global-property apiTests=false,modelTests=false \
+    --global-property apiDocs=false,modelDocs=False

localstack_sdk_python-4.3.0/localstack-sdk-python/localstack/sdk/aws/client.py

@@ -0,0 +1,186 @@
+import json
+
+from localstack.sdk.api.aws_api import AwsApi
+from localstack.sdk.clients import BaseClient
+from localstack.sdk.models import (
+    Message,
+    SesSentEmail,
+    SNSPlatformEndpointResponse,
+    SNSSMSMessagesResponse,
+)
+
+
+def _from_sqs_query_to_json(xml_dict: dict) -> list[Message]:
+    """
+    todo: developer endpoint implements sqs-query protocol. Remove this workaround one we move them to json.
+    """
+    raw_messages = (
+        xml_dict.get("ReceiveMessageResponse", {}).get("ReceiveMessageResult", {}) or {}
+    ).get("Message", [])
+    if isinstance(raw_messages, dict):
+        raw_messages = [raw_messages]
+    messages = []
+    for msg in raw_messages:
+        _attributes = msg.get("Attribute", [])
+        attributes = {i["Name"]: i["Value"] for i in _attributes}
+        _m = {
+            "MessageId": msg.get("MessageId"),
+            "ReceiptHandle": msg.get("ReceiptHandle"),
+            "MD5OfBody": msg.get("MD5OfBody"),
+            "Body": msg.get("Body"),
+            "Attributes": attributes,
+        }
+        m = Message.from_dict(_m)
+        messages.append(m)
+    return messages
+
+
+class AWSClient(BaseClient):
+    """
+    The client to interact with all the LocalStack's AWS endpoints.
+    These endpoints offer specific features in addition to the ones offered by the AWS services. For instance,
+    access all the messages withing a SQS without the side effect of deleting them.
+    """
+
+    def __init__(self, **kwargs) -> None:
+        super().__init__(**kwargs)
+        self._client = AwsApi(self._api_client)
+
+    ########
+    # SQS
+    ########
+
+    def list_sqs_messages(self, account_id: str, region: str, queue_name: str) -> list[Message]:
+        """
+        Lists all the SQS messages in a given queue in a specific account id and region, without any side effect.
+
+        :param account_id: the account id of the queue
+        :param region: the region of the queue
+        :param queue_name: the name of the queue
+        :return: the list of messages in the queue
+        """
+        response = self._client.list_sqs_messages_with_http_info(
+            account_id=account_id, region=region, queue_name=queue_name
+        )
+        return _from_sqs_query_to_json(json.loads(response.raw_data))
+
+    def list_sqs_messages_from_queue_url(self, queue_url: str) -> list[Message]:
+        """
+        Lists all the SQS messages in a given queue, without any side effect.
+
+        :param queue_url: the URL of the queue
+        :return: the list of messages in the queue
+        """
+        response = self._client.list_all_sqs_messages_with_http_info(queue_url=queue_url)
+        return _from_sqs_query_to_json(json.loads(response.raw_data))
+
+    ########
+    # SES
+    ########
+
+    def get_ses_messages(
+        self, id_filter: str | None = None, email_filter: str | None = None
+    ) -> list[SesSentEmail]:
+        """
+        Returns all the in-memory saved SES messages. They can be filtered by message ID and/or message source.
+
+        :param id_filter: the message id used as filter for the SES messages
+        :param email_filter: the message source filter
+        :return: a list of email sent with SES
+        """
+        response = self._client.get_ses_messages(id=id_filter, email=email_filter)
+        return response.messages
+
+    def discard_ses_messages(self, id_filter: str | None = None) -> None:
+        """
+        Clears all SES messages. An ID filter can be provided to delete only a specific message.
+
+        :param id_filter: the id filter
+        :return: None
+        """
+        return self._client.discard_ses_messages(id=id_filter)
+
+    ########
+    # SNS
+    ########
+
+    def get_sns_sms_messages(
+        self,
+        phone_number: str | None = None,
+        account_id: str = "000000000000",
+        region: str = "us-east-1",
+    ) -> SNSSMSMessagesResponse:
+        """
+        Returns all SMS messages published to a phone number.
+
+        :param phone_number: the phone number to which the messages have been published. If not specified, all messages
+            are returned.
+        :param account_id: the AWS Account ID from which the messages have been published. '000000000000' by default
+        :param region:  the AWS region from which the messages have been published. us-east-1 by default
+        :return:
+        """
+        return self._client.get_sns_sms_messages(
+            phone_number=phone_number, account_id=account_id, region=region
+        )
+
+    def discard_sns_sms_messages(
+        self,
+        phone_number: str | None = None,
+        account_id: str = "000000000000",
+        region: str = "us-east-1",
+    ) -> None:
+        """
+        Discards all SMS messages published to a phone number.
+
+        :param phone_number: the phone number to which the messages have been published. If not specified, all messages
+            are deleted.
+        :param account_id: the AWS Account ID from which the messages have been published. '000000000000' by default
+        :param region:  the AWS region from which the messages have been published. us-east-1 by default
+        :return: None
+        """
+        return self._client.discard_sns_sms_messages(
+            phone_number=phone_number, account_id=account_id, region=region
+        )
+
+    def get_sns_endpoint_messages(
+        self,
+        endpoint_arn: str | None = None,
+        account_id: str = "000000000000",
+        region: str = "us-east-1",
+    ) -> SNSPlatformEndpointResponse:
+        """
+        Returns all the messages published to a platform endpoint.
+
+        :param endpoint_arn: the ARN to which the messages have been published. If not specified, will return all the
+            messages.
+        :param account_id: the AWS Account ID from which the messages have been published. 000000000000 if not specified
+        :param region: the AWS region from which the messages have been published. us-east-1 by default
+        :return: a response with the list of messages and the queried region
+        """
+        return self._client.get_sns_endpoint_messages(
+            endpoint_arn=endpoint_arn, account_id=account_id, region=region
+        )
+
+    def discard_sns_endpoint_messages(
+        self,
+        endpoint_arn: str | None = None,
+        account_id: str = "000000000000",
+        region: str = "us-east-1",
+    ) -> None:
+        """
+        Discards all the messaged published to a platform endpoint.
+
+        :param endpoint_arn: the ARN to which the messages have been published. If not specified, will discard all the
+            messages.
+        :param account_id: the AWS Account ID from which the messages have been published. 000000000000 if not specified
+        :param region: the AWS region from which the messages have been published. us-east-1 by default
+        :return: None
+        """
+        return self._client.discard_sns_endpoint_messages(
+            endpoint_arn=endpoint_arn, account_id=account_id, region=region
+        )
+
+
+def get_default(**args) -> AwsApi:
+    """Return a client with a default configuration"""
+    return AwsApi(args)

localstack_sdk_python-4.3.0/localstack-sdk-python/localstack/sdk/chaos/client.py

@@ -0,0 +1,69 @@
+from localstack.sdk.api.chaos_api import ChaosApi
+from localstack.sdk.clients import BaseClient
+from localstack.sdk.models import FaultRule, NetworkEffectsConfig
+
+
+class ChaosClient(BaseClient):
+    """
+    The client to interact with the LocalStack's Chaos API.
+    """
+
+    def __init__(self, **kwargs) -> None:
+        super().__init__(**kwargs)
+        self._client = ChaosApi(self._api_client)
+
+    def set_fault_rules(self, fault_rules: list[FaultRule]) -> list[FaultRule]:
+        """
+        Creates a new sets of fault rules. It overwrites the previous ones.
+        :param fault_rules: the list of FaultRule we want to set
+        :return: the list of FaultRule currently in place
+        """
+        return self._client.set_fault_rules(fault_rule=fault_rules)
+
+    def add_fault_rules(self, fault_rules: list[FaultRule]) -> list[FaultRule]:
+        """
+        Adds a new set of rules to the current fault configuration.
+        :param fault_rules: the FaultRule rules to add
+        :return: the list of FaultRule currently in place
+        """
+        return self._client.add_fault_rules(fault_rule=fault_rules)
+
+    def delete_fault_rules(self, fault_rules: list[FaultRule]) -> list[FaultRule]:
+        """
+        Deletes a set of rules from the fault configuration.
+        :param fault_rules: the FaultRule to delete
+        :return: the list of FaultRule currently in place
+        """
+        return self._client.delete_fault_rules(fault_rule=fault_rules)
+
+    def get_fault_rules(self) -> list[FaultRule]:
+        """
+        Gets the current fault configuration.
+        :return: the list of FaultRule of the current configuration
+        """
+        return self._client.get_fault_rules()
+
+    def get_network_effects(self) -> NetworkEffectsConfig:
+        """
+        Gets the current network effect configuration.
+        :return: the current NetworkEffectsConfig
+        """
+        return self._client.get_network_effects()
+
+    def set_network_effects(
+        self, network_effects_config: NetworkEffectsConfig
+    ) -> NetworkEffectsConfig:
+        """
+        Configure a new network effect, e.g, latency.
+        :param network_effects_config: the network config to be set
+        :return: the current configuration of network effects
+        """
+        return self._client.set_network_effects(network_effects_config=network_effects_config)
+
+
+def get_default(**args) -> ChaosClient:
+    """
+    Return a chaos client with a default configuration. You can pass a host argument to overwrite the fault one
+    (http://localhost.localstack.cloud:4566).
+    """
+    return ChaosClient(**args)

{localstack_sdk_python-0.0.3 → localstack_sdk_python-4.3.0}/localstack-sdk-python/localstack/sdk/chaos/managers.py

@@ -6,6 +6,11 @@ from localstack.sdk.models import FaultRule
 
 @contextmanager
 def fault_configuration(fault_rules: list[FaultRule]):
+    """
+    This is a context manager that temporarily applies a given set of fault rules.
+    :param fault_rules: a list of FaultRule to be applied.
+    :return: None
+    """
     client = get_default()
     try:
         client.set_fault_rules(fault_rules=fault_rules)

localstack_sdk_python-4.3.0/localstack-sdk-python/localstack/sdk/clients.py

@@ -0,0 +1,35 @@
+from localstack.sdk import version
+from localstack.sdk.api_client import ApiClient
+from localstack.sdk.configuration import Configuration
+
+
+class BaseClient:
+    """
+    A BaseClient creates a configuration and instantiate a ApiClient, which is a generic OpenAPI client automatically
+    generated by the openapitools/openapi-generator tool.
+    """
+
+    configuration: Configuration
+    """The configuration for the base client"""
+    _api_client: ApiClient
+    """The OpenAPI client"""
+    host: str
+    """The LocalStack host (http://localhost.localstack.cloud:4566 by default)"""
+    auth_token: str | None
+    """A client can be injected with a LocalStack auth token. If not provided, the one used to start up the
+    LocalStack instance will be used (for the features needing it, e.g., Cloud Pods)."""
+
+    def __init__(self, host: str | None = None, auth_token: str | None = None, **kwargs) -> None:
+        """
+        Initializes a base client to interact with LocalStack developer endpoint.
+        :param host: the host, http://localhost.localstack.cloud:4566 by default.
+        :param auth_token: if provided, this token would be used for authentication against platform. It not, the
+            LocalStack runtime will use the one used to start the container. The token used determines the Cloud
+            Pods identity, i.e., which pods are available.
+        """
+        self.host = host or "http://localhost.localstack.cloud:4566"
+        self.auth_token = auth_token
+        self.configuration = Configuration(host=self.host)
+        self._api_client = ApiClient(configuration=self.configuration)
+        # The generated code comes with 1.0.0 hard-coded. We set here the correct version
+        self._api_client.user_agent = f"LocalStack SDK/{version.version}/python"