Repository files navigation

This is the Python SDK for LocalStack.LocalStack offers a number of developer endpoints (seedocs).This SDK provides a programmatic and easy way to interact with them.

This project is composed by two Python packages:

• packages/localstack-sdk-generated: generated from the LocalStack's OpenAPI specs withopenapi-generator.The LocalStack's OpenAPI specs are available inlocalstack/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 consumedlocalstack-sdk-generated as its main dependency.

You can install the LocalStack Python SDK withpip:

pip install localstack-sdk-python

This project usesuv as a package manager.On a Unix system, you can installuv with the standalone installer:

curl -LsSf https://astral.sh/uv/install.sh| sh

Onceuv is installed, you can install the project from source with:

make install

To run the integration test suite:

maketest

Note that LocalStack Pro (with the same version as the SDK) should be running in the background to execute the test.

To get started with our SDK, check out theofficial documentation on https://docs.localstack.cloud.You'll find comprehensive guides and detailed code samples that demonstrate how to use the various features providedby the SDK.