Skip to main content

Helper utilities for boto3

Project description

boto3_helpers is a Python library that aims to provide a smoother interface for some of the functions in the AWS boto3 package.

You know how to install it:

pip install boto3-helpers

Have you ever seen anybody make this mistake?

from boto3 import resource as boto3_resource
from boto3.dynamodb.conditions import Key

# Don't do this; you'll miss out if there is more than one page
ddb_table = boto3.resource('dynamodb').Table('example-table')
resp = ddb_table.query(
    KeyConditionExpression=Key('username').eq('johndoe')
)
for item in resp.get('Items', []):
    print(item)

What they should have done is this:

from boto3 import resource as boto3_resource
from boto3.dynamodb.conditions import Key

# Loop through all the pages
ddb_table = boto3.resource('dynamodb').Table('example-table')
kwargs = {'KeyConditionExpression': Key('username').eq('johndoe')}
while True:
    resp = ddb_table.query(**kwargs)
    for item in resp.get('Items', []):
        print(item)
    if 'LastEvaluatedKey' not in resp:
        break
    kwargs['ExclusiveStartKey'] = resp['LastEvaluatedKey']

With boto3_helpers, you can do the right thing more easily:

from boto3 import resource as boto3_resource
from boto3.dynamodb.conditions import Key
from boto3_helpers.dynamodb import query_table

ddb_table = boto3.resource('dynamodb').Table('example-table')
for item in query_table(
    ddb_table, KeyConditionExpression=Key('username').eq('johndoe')
):
    print(item)

This package provides helper functions for several similar actions in AWS, such as:

  • Paging through S3 listings

  • Updating items in DynamoDB

  • Assuming roles with STS

  • Sending and deleting messages with SQS

  • Pulling metric data from CloudWatch

See the latest docs for more.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

boto3-helpers-1.2.0.tar.gz (16.6 kB view details)

Uploaded Source

Built Distribution

boto3_helpers-1.2.0-py3-none-any.whl (19.8 kB view details)

Uploaded Python 3

File details

Details for the file boto3-helpers-1.2.0.tar.gz.

File metadata

  • Download URL: boto3-helpers-1.2.0.tar.gz
  • Upload date:
  • Size: 16.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.7

File hashes

Hashes for boto3-helpers-1.2.0.tar.gz
Algorithm Hash digest
SHA256 4322e9bcaf4dd91a292bcc160007e4bdd59d8a606fa33935d8341b88fae176c2
MD5 70b88e2c25806aaf30a11b92f148cf6f
BLAKE2b-256 b85da74e567108ea07149179d73d792b0cbc94685849a41b3eb1201b76901069

See more details on using hashes here.

File details

Details for the file boto3_helpers-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for boto3_helpers-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9dd62cbba66031f613e282fca8e1731f1b1dc5eacd7edfcf62d981ce37379a6d
MD5 b487931f3c01568fe9a43483eaadcad5
BLAKE2b-256 b5066794b8d8beafc1b9961174b36d0f505658be2faf5298e2f62bd0932ba552

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page