Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/localstack/localstack

๐Ÿ’ป A fully functional local AWS cloud stack. Develop and test your cloud & Serverless apps offline
https://github.com/localstack/localstack

aws cloud continuous-integration developer-tools localstack python testing

Last synced: about 2 months ago
JSON representation

๐Ÿ’ป A fully functional local AWS cloud stack. Develop and test your cloud & Serverless apps offline

Lists

README 

        


:zap: We are excited to announce that we released LocalStack 3.0! You can find all information about the release and the new features in our blog :zap:






  LocalStack - A fully functional local cloud stack






  CircleCI

  Coverage Status

  PyPI Version

  Docker Pulls

  PyPi downloads

  Backers on Open Collective

  Sponsors on Open Collective

  PyPI License

  Code style: black

  Twitter






  LocalStack is a cloud software development framework to develop and test your AWS applications locally.






  Overview โ€ข

  Install โ€ข

  Quickstart โ€ข

  Run โ€ข

  Usage โ€ข

  Releases โ€ข

  Contributing

  


  ๐Ÿ“– Docs โ€ข

  ๐Ÿ’ป Pro version โ€ข

  โ˜‘๏ธ LocalStack coverage




---



# Overview



[LocalStack](https://localstack.cloud) is a cloud service emulator that runs in a single container on your laptop or in your CI environment. With LocalStack, you can run your AWS applications or Lambdas entirely on your local machine without connecting to a remote cloud provider! Whether you are testing complex CDK applications or Terraform configurations, or just beginning to learn about AWS services, LocalStack helps speed up and simplify your testing and development workflow.



LocalStack supports a growing number of AWS services, like AWS Lambda, S3, Dynamodb, Kinesis, SQS, SNS, and many more! The [Pro version of LocalStack](https://localstack.cloud/pricing) supports additional APIs and advanced features. You can find a comprehensive list of supported APIs on our [โ˜‘๏ธ Feature Coverage](https://docs.localstack.cloud/user-guide/aws/feature-coverage/) page.



LocalStack also provides additional features to make your life as a cloud developer easier! Check out LocalStack's [User Guides](https://docs.localstack.cloud/user-guide/) for more information.



## Installation



The quickest way get started with LocalStack is by using the LocalStack CLI. It enables you to start and manage the LocalStack Docker container directly through your command line. Ensure that your machine has a functional [`docker` environment](https://docs.docker.com/get-docker/) installed before proceeding.



### Brew (macOS or Linux with Homebrew)



Install the LocalStack CLI through our [official LocalStack Brew Tap](https://github.com/localstack/homebrew-tap):



```bash

brew install localstack/tap/localstack-cli

```



### Binary download (MacOS, Linux, Windows)



If Brew is not installed on your machine, you can download the pre-built LocalStack CLI binary directly:



- Visit [localstack/localstack-cli](https://github.com/localstack/localstack-cli/releases/latest) and download the latest release for your platform.

- Extract the downloaded archive to a directory included in your `PATH` variable:

    -   For MacOS/Linux, use the command: `sudo tar xvzf ~/Downloads/localstack-cli-*-darwin-*-onefile.tar.gz -C /usr/local/bin`



### PyPI (MacOS, Linux, Windows)



LocalStack is developed using Python. To install the LocalStack CLI using `pip`, run the following command:



```bash

python3 -m pip install localstack

```



The `localstack-cli` installation enables you to run the Docker image containing the LocalStack runtime. To interact with the local AWS services, you need to install the `awslocal` CLI separately. For installation guidelines, refer to the [`awslocal` documentation](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal).



> **Important**: Do not use `sudo` or run as `root` user. LocalStack must be installed and started entirely under a local non-root user. If you have problems with permissions in macOS High Sierra, install with `pip install --user localstack`



## Quickstart



Start LocalStack inside a Docker container by running:



```bash

 % localstack start -d



     __                     _______ __             __

    / /   ____  _________ _/ / ___// /_____ ______/ /__

   / /   / __ \/ ___/ __ `/ /\__ \/ __/ __ `/ ___/ //_/

  / /___/ /_/ / /__/ /_/ / /___/ / /_/ /_/ / /__/ ,<

 /_____/\____/\___/\__,_/_//____/\__/\__,_/\___/_/|_|



 ๐Ÿ’ป LocalStack CLI 3.1.0

 ๐Ÿ‘ค Profile: default



[12:47:13] starting LocalStack in Docker mode ๐Ÿณ                       localstack.py:494

           preparing environment                                       bootstrap.py:1240

           configuring container                                       bootstrap.py:1248

           starting container                                          bootstrap.py:1258

[12:47:15] detaching                                                   bootstrap.py:1262

```



You can query the status of respective services on LocalStack by running:



```bash

% localstack status services

โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“

โ”ƒ Service                  โ”ƒ Status      โ”ƒ

โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ

โ”‚ acm                      โ”‚ โœ” available โ”‚

โ”‚ apigateway               โ”‚ โœ” available โ”‚

โ”‚ cloudformation           โ”‚ โœ” available โ”‚

โ”‚ cloudwatch               โ”‚ โœ” available โ”‚

โ”‚ config                   โ”‚ โœ” available โ”‚

โ”‚ dynamodb                 โ”‚ โœ” available โ”‚

...

```



To use SQS, a fully managed distributed message queuing service, on LocalStack, run:



```shell

% awslocal sqs create-queue --queue-name sample-queue

{

    "QueueUrl": "http://sqs.us-east-1.localhost.localstack.cloud:4566/000000000000/sample-queue"

}

```



Learn more about [LocalStack AWS services](https://docs.localstack.cloud/references/coverage/) and using them with LocalStack's `awslocal` CLI.



## Running



You can run LocalStack through the following options:



- [LocalStack CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli)

- [Docker](https://docs.localstack.cloud/getting-started/installation/#docker)

- [Docker Compose](https://docs.localstack.cloud/getting-started/installation/#docker-compose)

- [Helm](https://docs.localstack.cloud/getting-started/installation/#helm)



## Usage



To start using LocalStack, check out our [documentation](https://docs.localstack.cloud).



- [LocalStack Configuration](https://docs.localstack.cloud/references/configuration/)

- [LocalStack in CI](https://docs.localstack.cloud/user-guide/ci/)

- [LocalStack Integrations](https://docs.localstack.cloud/user-guide/integrations/)

- [LocalStack Tools](https://docs.localstack.cloud/user-guide/tools/)

- [Understanding LocalStack](https://docs.localstack.cloud/references/)

- [Frequency Asked Questions](https://docs.localstack.cloud/getting-started/faq/)



To use LocalStack with a graphical user interface, you can use the following UI clients:



* [LocalStack Web Application](https://app.localstack.cloud)

* [LocalStack Desktop](https://docs.localstack.cloud/user-guide/tools/localstack-desktop/)

* [LocalStack Docker Extension](https://docs.localstack.cloud/user-guide/tools/localstack-docker-extension/)



## Releases



Please refer to [GitHub releases](https://github.com/localstack/localstack/releases) to see the complete list of changes for each release. For extended release notes, please refer to the [LocalStack Discuss](https://discuss.localstack.cloud/c/announcement/5).



## Contributing



If you are interested in contributing to LocalStack:



- Start by reading our [contributing guide](CONTRIBUTING.md).

- Check out our [developer guide](https://docs.localstack.cloud/contributing/).

- Navigate our codebase and [open issues](https://github.com/localstack/localstack/issues).



We are thankful for all the contributions and feedback we receive.



## Get in touch



Get in touch with the LocalStack Team to

report ๐Ÿž [issues](https://github.com/localstack/localstack/issues/new/choose),

upvote ๐Ÿ‘ [feature requests](https://github.com/localstack/localstack/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+),

๐Ÿ™‹๐Ÿฝ ask [support questions](https://docs.localstack.cloud/getting-started/help-and-support/),

or ๐Ÿ—ฃ๏ธ discuss local cloud development:



- [LocalStack Slack Community](https://localstack.cloud/contact/)

- [LocalStack Discussion Page](https://discuss.localstack.cloud/)

- [LocalStack GitHub Issue tracker](https://github.com/localstack/localstack/issues)



### Contributors



We are thankful to all the people who have contributed to this project.






### Backers



We are also grateful to all our backers who have donated to the project. You can become a backer on [Open Collective](https://opencollective.com/localstack#backer).






### Sponsors



You can also support this project by becoming a sponsor on [Open Collective](https://opencollective.com/localstack#sponsor). Your logo will show up here along with a link to your website.
























## License



Copyright (c) 2017-2024 LocalStack maintainers and contributors.



Copyright (c) 2016 Atlassian and others.



This version of LocalStack is released under the Apache License, Version 2.0 (see [LICENSE](LICENSE.txt)). By downloading and using this software you agree to the [End-User License Agreement (EULA)](doc/end_user_license_agreement). To know about the external software we use, look at our [third party software tools](doc/third-party-software-tools/README.md) page.