Skip to main content

LocalStack - A fully functional local Cloud stack

Project description

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 provides an easy-to-use test/mocking framework for developing Cloud applications.

OverviewInstallExampleRunUsageChangelogContributing

📖 Docs💻 Pro version☑️ Feature coverage📢 Announcements


Overview

LocalStack 💻 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 supports additional APIs and advanced features. You can find a comprehensive list of supported APIs on our ☑️ Feature Coverage page.

LocalStack also provides additional features to make your life as a cloud developer easier! Check out LocalStack's Cloud Developer Tools for more information.

Requirements

  • python (Python 3.6 up to 3.10 supported)
  • pip (Python package manager)
  • Docker

Installing

The easiest way to install LocalStack is via pip:

pip install localstack

Note: Please do not use sudo or the root user - LocalStack should 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

It installs the localstack-cli which is used to run the Docker image that hosts the LocalStack runtime.

Example

Start LocalStack inside a Docker container by running:

 % localstack start -d

     __                     _______ __             __
    / /   ____  _________ _/ / ___// /_____ ______/ /__
   / /   / __ \/ ___/ __ `/ /\__ \/ __/ __ `/ ___/ //_/
  / /___/ /_/ / /__/ /_/ / /___/ / /_/ /_/ / /__/ ,<
 /_____/\____/\___/\__,_/_//____/\__/\__,_/\___/_/|_|

 💻 LocalStack CLI 0.14.3

[20:22:20] starting LocalStack in Docker mode 🐳
[20:22:21] detaching

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

% 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:

% awslocal sqs create-queue --queue-name sample-queue
{
    "QueueUrl": "http://localhost:4566/000000000000/sample-queue"
}

Learn more about LocalStack AWS services and using them with LocalStack's awslocal CLI.

Running

You can run LocalStack through the following options:

Usage

To start using LocalStack, check out our documentation on docs.localstack.cloud.

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

Change Log

Please refer to CHANGELOG.md to see the complete list of changes for each release.

Contributing

If you are interested in contributing to LocalStack:

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

Get in touch

To get in touch with LocalStack team for bugs/feature requests, support questions or general discussions, please use:

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.

Sponsors

You can also support this project by becoming a sponsor on Open Collective. Your logo will show up here along with a link to your website.

License

Copyright (c) 2017-2021 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.txt). By downloading and using this software you agree to the End-User License Agreement (EULA). To know about the external software we use, look at our third party software tools page.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dummy-localstack-0.16.8.tar.gz (863.1 kB view details)

Uploaded Source

Built Distribution

dummy_localstack-0.16.8-py3-none-any.whl (984.9 kB view details)

Uploaded Python 3

File details

Details for the file dummy-localstack-0.16.8.tar.gz.

File metadata

  • Download URL: dummy-localstack-0.16.8.tar.gz
  • Upload date:
  • Size: 863.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for dummy-localstack-0.16.8.tar.gz
Algorithm Hash digest
SHA256 dfbd55521708dc4570db2b3d4f6c5cd3f4fa21df7fd19bd6214348af073291b3
MD5 6c94b4c7702ead14581e46df39c2f894
BLAKE2b-256 7c2982df708216cff568ad345964ec6347e384e3d82e4b8c0926dcbc8faf4a87

See more details on using hashes here.

File details

Details for the file dummy_localstack-0.16.8-py3-none-any.whl.

File metadata

File hashes

Hashes for dummy_localstack-0.16.8-py3-none-any.whl
Algorithm Hash digest
SHA256 46017099388c1e50833c1e9cedab66e86e8489ccabb1a49ac8bc6622628a2568
MD5 79c8296b388a92c032e5bc487d066ce8
BLAKE2b-256 f3a76b6813250a8e33a459d2e74191b5fb9cfaa96a35413d51e9991897a23edb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page