This is the Python SDK for LocalStack. LocalStack offers a number of developer endpoints (see docs). 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.
This project is composed by two Python packages:
packages/localstack-sdk-generated
: generated from the LocalStack's OpenAPI specs with openapi-generator. The LocalStack's OpenAPI specs are available in 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 consumedlocalstack-sdk-generated
as its main dependency.
You can install the LocalStack Python SDK with pip
:
pip install localstack-sdk-python
This project uses uv as a package manager.
On a Unix system, you can install uv
with the standalone installer:
curl -LsSf https://astral.sh/uv/install.sh | sh
Once uv
is installed, you can install the project from source with:
make install
To run the integration test suite:
make test
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 the official documentation on https://docs.localstack.cloud. You'll find comprehensive guides and detailed code samples that demonstrate how to use the various features provided by the SDK.