b3u 1.2.1

Utility for extracting Boto3 configuration information and method parameters from AWS resource URIs.

Boto3 URI utility library that supports extraction of Boto3 configuration data and method parameters from AWS resource URIs.

Purpose

When applications that employ Boto3 must work with AWS resources that are spread across multiple accounts, it can be useful to tie AWS configuration information (both credentials and non-credentials) directly to associated AWS resources (e.g., by including the configuration data within URIs). This library provides methods that extract AWS configuration data and method parameters from URIs, offering a succinct syntax for passing (directly into Boto3 methods) configuration data and/or resource names that are included within URIs.

Package Installation and Usage

The package is available on PyPI:

python -m pip install b3u

The library can be imported in the usual ways:

import b3u
from b3u import *

Examples

The library provides methods for extracting configuration data (credentials and non-credentials) from URIs. The example below illustrates the creation of an S3 client object from a given a URI (for an S3 bucket), where the URI includes credentials (an access key ABC, a secret key XYZ, and a session token UVW):

>>> import boto3
>>> import b3u
>>> boto3.client('s3', **b3u.cred("s3://ABC:XYZ:UVW@example-bucket"))

The example below creates an S3 client given a URI (for an object in an S3 bucket) where the URI includes credentials (an access key ABC and a secret key XYZ). The same URI is then used to retrieve a handle for the object itself:

>>> uri = "s3://ABC:XYZ@example-bucket/object.data"
>>> c = boto3.client(**b3u.for_client(uri))
>>> o = c.get_object(**b3u.for_get(uri))

The example below creates an SSM client given a URI (naming a particular a parameter in the Parameter Store) that specifies the AWS Region us-east-1:

>>> boto3.client('ssm', **b3u.conf("ssm://ABC:XYZ@/path/to/parameter?region_name=us-east-1"))

The example below creates an SSM client given a URI that contains no credentials but does specify an AWS Region. Since no credentials are present in the URI, the Boto3 Python library will look for them in other locations in the manner specified in the Boto3 documentation):

>>> boto3.client('ssm', **b3u.conf("ssm:///path/to/parameter?region_name=us-east-1"))

Documentation

The documentation can be generated automatically from the source files using Sphinx:

cd docs
python -m pip install -r requirements.txt
sphinx-apidoc -f -E --templatedir=_templates -o _source .. ../setup.py && make html

Testing and Conventions

All unit tests are executed and their coverage is measured when using nose (see setup.cfg for configuration details):

python -m pip install nose coverage
nosetests --cover-erase

Alternatively, all unit tests are included in the module itself and can be executed using doctest:

python b3u/b3u.py -v

Style conventions are enforced using Pylint:

python -m pip install pylint
pylint b3u

Contributions

In order to contribute to the source code, open an issue or submit a pull request on the GitHub page for this library.

Versioning

The version number format for this library and the changes to the library associated with version number increments conform with Semantic Versioning 2.0.0.