Metadata-Version: 1.1
Name: boto3facade
Version: 0.1.0
Summary: A simple facade for boto3
Home-page: http://github.com/InnovativeTravel/boto3facade
Author: German Gomez-Herrero
Author-email: german@innovativetravel.eu
License: MIT
Description: boto3facade
        ===========
        
        |Circle CI| |PyPI|
        
        A simple facade for `boto3 <https://github.com/boto/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 <https://aws.amazon.com/ec2/>`__. 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 <https://github.com/boto/boto3>`__. For instance in the EC2 facade:
        
        .. code:: python
        
            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:
        
        .. code:: python
        
            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?
        -------------
        
        -  German Gomez-Herrero, german@innovativetravel.eu
        
        .. |Circle CI| image:: https://circleci.com/gh/InnovativeTravel/boto3facade.svg?style=svg
           :target: https://circleci.com/gh/InnovativeTravel/boto3facade
        .. |PyPI| image:: https://img.shields.io/pypi/v/boto3facade.svg?style=flat
           :target: https://pypi.python.org/pypi/boto3facade
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
