localstack-sdk-python 0.0.4__tar.gz → 4.4.0__tar.gz

localstack_sdk_python-4.4.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-4.4.0/.github/workflows/test.yml

@@ -0,0 +1,63 @@
+name: Python LocalStack Client / Run Test
+
+on:
+  pull_request:
+    paths:
+      - .github/workflows/test.yml
+      - localstack-sdk-python/**
+      - tests/**
+      - packages/**
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+
+  test_python:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - 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: Install project
+      run: |
+        make install-dev
+
+    - name: Install LocalStack
+      run: |
+        pip install --pre --upgrade localstack
+
+    - name: Pull image
+      run: |
+        docker pull localstack/localstack-pro
+
+    - 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:latest" 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: always()
+      run: |
+          source .venv/bin/activate
+          localstack logs
+          localstack stop

localstack_sdk_python-4.4.0/.gitignore

@@ -0,0 +1,72 @@
+*.pyc
+*.pyo
+*.log
+*.keys.json
+/nosetests.xml
+/.venv*
+*/.venv*
+*/.mypy_cache
+.settings/
+.project
+.classpath
+.coverage*
+.DS_Store
+/build/
+dist/
+*.egg-info/
+.eggs/
+*.sw*
+~*
+*~
+.idea/
+*.iml
+.vscode/
+
+node_modules/
+app/build
+package-lock.json
+
+.serverless
+
+target/
+
+testdata/
+
+etc/docker/lambda/*.tmp
+etc/docker/lambda/Dockerfile
+etc/docker/lambda/entrypoint.sh
+
+*.crt
+!localstack-pro-azure/localstack/pro/azure/server/proxy/ca.crt
+
+backend_states/
+api_states/
+.python_packages/
+
+terraform.tfstate*
+.terraform*
+**/terraform/tfplan
+.env
+
+# test resources
+metastore_db/
+parity-metrics/
+.pytest-report.xml
+*.raw.snapshot.json
+localstack-pro-azure/visited_urls.csv
+localstack-pro-azure/implemented_features.csv
+localstack-pro-azure/tests/otherlangs/scripts/website/.azure/config
+
+# dotnet files
+localstack-pro-azure/tests/otherlangs/dotnet/*/bin
+localstack-pro-azure/tests/otherlangs/dotnet/*/obj
+
+# setuptools_scm version.py
+*/*/*/*/version.py
+localstack-sdk-python-2/.openapi-generator/
+
+# setuptools_scm version.py
+**/version.py
+
+# release helper
+bin/release-helper.sh

localstack_sdk_python-4.4.0/Makefile

@@ -0,0 +1,44 @@
+VENV_DIR ?= .venv
+VENV_RUN = . $(VENV_DIR)/bin/activate
+VENV_ACTIVATE = $(VENV_DIR)/bin/activate
+TEST_PATH ?= .
+TEST_EXEC ?= python -m
+PYTEST_LOGLEVEL ?= warning
+
+install:			## omit dev dependencies
+	uv venv
+	uv sync --no-dev
+
+install-dev:		## create the venv and install
+	uv venv
+	uv sync
+
+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 .)
+
+lint:
+	($(VENV_RUN); python -m ruff check --exclude packages --output-format=full . && python -m ruff format --exclude packages --check .)
+
+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 clean clean-dist clean-generated generate build publish format lint test

localstack_sdk_python-4.4.0/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: localstack-sdk-python
+Version: 4.4.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.4.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.4.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-0.0.4 → localstack_sdk_python-4.4.0}/localstack-sdk-python/localstack/sdk/clients.py

@@ -1,3 +1,4 @@
+from localstack.sdk import version
 from localstack.sdk.api_client import ApiClient
 from localstack.sdk.configuration import Configuration
 
@@ -30,3 +31,5 @@ class BaseClient:
         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"

localstack_sdk_python-4.4.0/localstack-sdk-python/localstack/sdk/version.py

@@ -0,0 +1,21 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '4.4.0'
+__version_tuple__ = version_tuple = (4, 4, 0)

localstack_sdk_python-4.4.0/localstack-sdk-python/localstack_sdk_python.egg-info/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: localstack-sdk-python
+Version: 4.4.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.