Skip to main content

A simple facade for boto3

Project description

Circle CI PyPI

A simple facade for boto3 that makes some common tasks easier. The boto3facade module is not intended to be used directly but as a shared components of projects that use boto3.

Installation

To install the development version:

pip install git+https://github.com/InnovativeTravel/boto3facade

To install the latest stable release:

pip install boto3facade

Quickstart

The boto3facade package contains a collection of modules that implement facades to different AWS services. For instnce the boto3facade.ec2 module implements the facade to AWS EC2 service. Each of these modules typically contain just one class, named as the corresponding AWS service. E.g. the boto3facade.ec2 module contains an Ec2 class. In some cases, there may also be public module functions that implement utilities that don’t require access to the AWS boto3 SDK. For instance in the EC2 facade:

import boto3facade.ec2 as ec2

# Get the name of the role associated to the EC2 instance
if ec2.in_ec2():
    # If this code is running in an EC2 instance
    role_name = ec2.get_instance_profile_role()
else:
    role_name = None

Facade methods that actually use the boto3 are implemented as instance methods:

from boto3facade.ec2 import Ec2

# Create the facade object
my_ec2_facade = Ec2()

# Get the list of AMIs that have tags matching the provided ones
ami_tags = {'Name': 'niceimage', 'Version', 'latest'}
ami_list = my_ec2_facade.get_ami_by_tag(ami_tags)

# Get the SecurityGroup boto3 resource with a certain name
my_sg = my_ec2_facade.get_sg_by_name('sgname')

Development

make develop
. .env/bin/activate

Who do I ask?

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

boto3facade-0.0.6.tar.gz (14.9 kB view hashes)

Uploaded Source

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