A tool for developing and testing AWS service integrations locally.
Project description
LocalCloudForge
Overview
LocalCloudForge is a library designed to simplify the process of working with AWS services in your local development environment. This library enables you to run your AWS service interactions locally, making it easier to test and develop your applications without incurring unnecessary costs. With just a simple decorator, you can enhance your development workflow, allowing you to focus on building your applications without worrying about cloud expenses.
Features
- Effortless Integration: Simply decorate any function that instantiates an AWS service with @forge_local, and it will automatically execute in your local environment.
- Support for Multiple AWS Services: Integrate with various AWS services like S3, SNS, SQS, Lambda, and more without additional configuration. You can check for avaiable services here
Getting Started
Requirements
To get started, ensure you have the following installed:
pip install boto3 localstack-client
Running LocalStack
Start LocalStack using Docker with the following command:
docker run -p 4566:4566 -p 4571:4571 localstack/localstack
Configuring AWS CLI for LocalStack
To interact with your LocalStack instance using the AWS CLI, you'll need to configure your AWS CLI settings. Add the following configurations to your AWS config and credentials files:
Update your AWS Config:
Create or edit ~/.aws/config
:
[profile localstack]
region = us-east-1
output = json
endpoint_url = http://localhost:4566
Update your AWS Credentials:
Create or edit ~/.aws/credentials
:
[localstack]
aws_access_key_id = test
aws_secret_access_key = test
Using the AWS CLI with LocalStack
Once configured, you can execute AWS CLI commands using the LocalStack profile. Simply add the --profile localstack
flag to your AWS CLI commands:
aws s3 ls --profile localstack
Example Usage
Here's a quick example of how to use the @forge_local
decorator:
from local_cloud_forge import forge_local
@forge_local
def create_bucket(bucket_name):
s3_client = boto3.client('s3')
s3_client.create_bucket(Bucket=bucket_name)
print(f"Bucket '{bucket_name}' created.")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for localcloudforge-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0384a383acbc26fbec01d8ead6e41a9cc357b5c78b9473c60b137999214e4c46 |
|
MD5 | 4fb2c5dba5db98b093afa74861205920 |
|
BLAKE2b-256 | 3717b9b7624eb277330efc126a9a1b2050cee961dcfd20edb9272d51a5e6be73 |