Package: b3q
Boto3 utility library that supports parameter-driven and predicate-driven retrieval of collections of AWS resources.PurposeThis library makes it possible to useBoto3to retrieve a collection of AWS resources (selected according to supplied parameters, constraints, and/or predicates) within an AWS service.Installation and UsageThis library is available as apackage on PyPI:python -m pip install b3qThe library can be imported in the usual ways:import b3q
from b3q import *ExamplesThe library make it possible to concisely retrieve all instances of an AWS resource (potentially spanning multiple pages of results). The library requires the use of theBoto3library to create a client object that can be used to retrieve information about AWS resources. In the example below, an AWS API Gateway client is created:>>> import boto3
>>> client = boto3.client('apigateway')In the example below, all custom domain name entries are retrieved:>>> import b3q
>>> ns = b3q.get(client.get_domain_names)The example below illustrates the retrieval of an API with the name'example_api':>>> apis = b3q.get(client.get_rest_apis, constraints={'name': 'example_api'})
>>> api = apis[0] # Assumes there is one result.The steps below retrieve all API deployments associated with the specific API retrieved above:>>> ds = b3q.get(client.get_deployments, arguments={'restApiId': api['id']})DevelopmentAll installation and development dependencies are fully specified inpyproject.toml. Theproject.optional-dependenciesobject is used tospecify optional requirementsfor various development tasks. This makes it possible to specify additional options (such asdocs,lint, and so on) when performing installation usingpip:python -m pip install .[docs,lint]DocumentationThe documentation can be generated automatically from the source files usingSphinx:python -m pip install .[docs]
cd docs
sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make htmlTesting and ConventionsAll unit tests are executed and their coverage is measured when usingpytest(see thepyproject.tomlfile for configuration details):python -m pip install .[test]
python -m pytestAlternatively, all unit tests are included in the module itself and can be executed usingdoctest:python src/b3q/b3q.py -vStyle conventions are enforced usingPylint:python -m pip install .[lint]
python -m pylint src/b3qContributionsIn order to contribute to the source code, open an issue or submit a pull request on theGitHub pagefor this library.VersioningThe version number format for this library and the changes to the library associated with version number increments conform withSemantic Versioning 2.0.0.PublishingThis library can be published as apackage on PyPIby a package maintainer. First, install the dependencies required for packaging and publishing:python -m pip install .[publish]Ensure that the correct version number appears inpyproject.toml, and that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has anautomation rulethat activates and sets as the default all tagged versions. Create and push a tag for this version (replacing?.?.?with the version number):git tag ?.?.?
git push origin ?.?.?Remove any old build/distribution files. Then, package the source into a distribution archive:rm -rf build dist src/*.egg-info
python -m build --sdist --wheel .Finally, upload the package distribution archive toPyPI:python -m twine upload dist/*