b3q 0.2.0

Boto3 utility library that supports parameter-driven and predicate-driven retrieval of collections of AWS resources.

Boto3 utility library that supports parameter-driven and predicate-driven retrieval of collections of AWS resources.

Purpose

This library makes it possible to use Boto3 to retrieve a collection of AWS resources (selected according to supplied parameters, constraints, and/or predicates) within an AWS service.

Package Installation and Usage

The package is available on PyPI:

python -m pip install b3q

The library can be imported in the usual ways:

import b3q
from b3q import *

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 configution 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 b3q/b3q.py -v

Style conventions are enforced using Pylint:

python -m pip install pylint
pylint b3q

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.