Package: b3u
Boto3 URI utility library that supports extraction of Boto3 configuration data and method parameters from AWS resource URIs.PurposeWhen applications that employBoto3must work with AWS resources that are spread across multiple accounts, it can be useful to tie AWS configuration information (bothcredentialsandnon-credentials) directly to associated AWS resources (e.g., by including the configuration data within URIs). This library provides a class that extracts AWS configuration data and method parameters from a URI, offering a succinct syntax for passing (directly into Boto3 methods) configuration data and/or resource names that are included within URIs.Package Installation and UsageThe package is available onPyPI:python -m pip install b3uThe b3u class can be imported with:from b3u import b3uExamplesThe class 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 keyABC, a secret keyXYZ, and a session tokenUVW):>>> import boto3
>>> from b3u import b3u
>>> b = b3u("s3://ABC:XYZ:UVW@example-bucket")
>>> boto3.client('s3', **b.cred())The example below creates an S3 client given a URI (for an object in an S3 bucket) where the URI includes credentials (an access keyABCand a secret keyXYZ). The same URI is then used to retrieve a handle for the object itself:>>> b = b3u("s3://ABC:XYZ@example-bucket/object.data")
>>> c = boto3.client(**b.for_client())
>>> o = c.get_object(**b.for_get())The example below creates an SSM client given a URI (naming a particular a parameter in the Parameter Store) that specifies the AWS Regionus-east-1:>>> b = b3u("ssm://ABC:XYZ@/path/to/parameter?region_name=us-east-1")
>>> boto3.client('ssm', **b.conf())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, theBoto3 Python librarywill look for them in other locations in the manner specified in the Boto3 documentation):>>> b = b3u("ssm:///path/to/parameter?region_name=us-east-1")
>>> boto3.client('ssm', **b.conf())Developer NotesPipenv is used for dependency management of the main library, minus Read the Docs which does not support Pipenv.
You can install all dependencies with:pipenv install --devTo release a new version of the library, run:pipenv run python -m pip install --upgrade build twine
pipenv run python -m build
pipenv run twine upload dist/*DocumentationThe documentation can be generated automatically from the source files usingSphinx:python -m pip install -e .
cd docs
python -m pip install -r requirements.txt
sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make htmlTesting and ConventionsAll unit tests are executed and their coverage is measured when usingpytest(seesetup.cfgfor configuration details):pipenv run python -m pytest --cov=b3u --cov-report term-missingAlternatively, all unit tests are included in the module itself and can be executed using doctest:pipenv run python src/b3u/b3u.py -vStyle conventions are enforced usingFlake8:pipenv run python -m flake8 src/ tests/ContributionsIn 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.MIT LicenseCopyright (c) 2021 Nth Party, Ltd.Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.