Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove docs & improve README #14

Merged
merged 5 commits into from
Dec 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 0 additions & 42 deletions .github/workflows/docs.yml

This file was deleted.

5 changes: 0 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,6 @@ clean-generated: ## Cleanup generated code
generate: ## Generate the code from the OpenAPI specs
./bin/generate.sh

sphinx-docs: ## Generate the documentation; uses the sphinx-generated Makefile in docs to clean and build html
($(VENV_RUN); sphinx-apidoc --implicit-namespaces -o docs localstack-sdk-python/localstack)
$(MAKE) -C docs clean
$(MAKE) -C docs html

format:
($(VENV_RUN); python -m ruff format --exclude packages .; python -m ruff check --output-format=full --exclude packages --fix .)

Expand Down
48 changes: 38 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# 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/)).
Expand All @@ -10,19 +11,46 @@ This SDK provides a programmatic and easy way to interact with them.

### Project Structure

This project follows the following structure:
This project is composed by two Python packages:

- `packages/localstack-sdk-generated` is a Python project generated from the OpenAPI specs with [openapi-generator](https://github.com/OpenAPITools/openapi-generator).
LocalStack's OpenAPI specs are available in the [openapi repository](https://github.com/localstack/openapi).
- `localstack-sdk-python` is the main project that has `localstack-sdk-generated` as the main dependency.
- `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.

Developers are not supposed to modify at all `localstack-sdk-generated`.
The code needs to be re-generated from specs every time using the `generate.sh` script in the `bin` folder.
### Installation

This project uses [uv](https://github.com/astral-sh/uv) as package/project manager.
You can install the LocalStack Python SDK with `pip`:

### Install & Run
```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
```

You can simply run `make install-dev` to install the two packages and the needed dependencies.
`make test` runs the test suite.
Note that LocalStack (pro) 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.
21 changes: 0 additions & 21 deletions docs/Makefile

This file was deleted.

Binary file removed docs/_static/localstack-horizontal.png
Binary file not shown.
59 changes: 0 additions & 59 deletions docs/conf.py

This file was deleted.

52 changes: 0 additions & 52 deletions docs/index.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/modules.rst

This file was deleted.

1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ dev-dependencies=[
"pytest>=8.3.3",
"ruff>=0.6.9",
"boto3>=1.35.40",
"sphinx>=8.1.3"
]

[tool.uv.sources]
Expand Down
Loading