You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
LocalStack offers a number of developer endpoints (see [docs](https://docs.localstack.cloud/references/internal-endpoints/)).
@@ -10,19 +11,46 @@ This SDK provides a programmatic and easy way to interact with them.
10
11
11
12
### Project Structure
12
13
13
-
This project follows the following structure:
14
+
This project is composed by two Python packages:
14
15
15
-
-`packages/localstack-sdk-generated` is a Python project generated from the OpenAPI specs with [openapi-generator](https://github.com/OpenAPITools/openapi-generator).
16
-
LocalStack's OpenAPI specs are available in the [openapi repository](https://github.com/localstack/openapi).
17
-
-`localstack-sdk-python` is the main project that has `localstack-sdk-generated` as the main dependency.
16
+
-`packages/localstack-sdk-generated`: generated from the LocalStack's OpenAPI specs with [openapi-generator](https://github.com/OpenAPITools/openapi-generator).
17
+
The LocalStack's OpenAPI specs are available in [localstack/openapi](https://github.com/localstack/openapi).
18
+
This package is not meant to be manually modified, as it needs to be generated every time from the specs.
19
+
-`localstack-sdk-python`: the user-facing SDK that consumed `localstack-sdk-generated` as its main dependency.
18
20
19
-
Developers are not supposed to modify at all `localstack-sdk-generated`.
20
-
The code needs to be re-generated from specs every time using the `generate.sh` script in the `bin` folder.
21
+
### Installation
21
22
22
-
This project uses [uv](https://github.com/astral-sh/uv) as package/project manager.
23
+
You can install the LocalStack Python SDK with `pip`:
23
24
24
-
### Install & Run
25
+
```shell
26
+
pip install localstack-sdk-python
27
+
```
28
+
29
+
#### From Source
30
+
31
+
This project uses [uv](https://github.com/astral-sh/uv) as a package manager.
32
+
On a Unix system, you can install `uv` with the standalone installer:
33
+
34
+
```shell
35
+
curl -LsSf https://astral.sh/uv/install.sh | sh
36
+
```
37
+
38
+
Once `uv` is installed, you can install the project from source with:
39
+
40
+
```shell
41
+
make install
42
+
```
43
+
44
+
To run the integration test suite:
45
+
46
+
```shell
47
+
make test
48
+
```
25
49
26
-
You can simply run `make install-dev` to install the two packages and the needed dependencies.
27
-
`make test` runs the test suite.
28
50
Note that LocalStack (pro) should be running in the background to execute the test.
51
+
52
+
### Quickstart
53
+
54
+
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/).
55
+
You'll find comprehensive guides and detailed code samples that demonstrate how to use the various features provided
0 commit comments