botowrap 0.1.1

A modular framework for extending boto3 clients with enhancements and features

botowrap

A modular framework for building and distributing "opinionated" wrappers around boto3 clients. Enhance your AWS SDK experience with powerful extensions that add developer-friendly features while maintaining the standard boto3 interface.

Out of the box it provides:

• DynamoDBDocumentExtension
  • Python↔DynamoDB (de)serialization
  • Auto‐CreatedAt/UpdatedAt timestamps
  • Jittered exponential backoff on throttling
  • query_all/scan_all pagination helpers
  • ConsumedCapacity logging

Installation

pip install botowrap

Usage

import logging
import boto3
from botowrap.core import ExtensionManager
from botowrap.extensions.dynamodb import (
    DynamoDBExtension, DynamoDBConfig
)

logging.basicConfig(level=logging.INFO)

# 1) Create the manager (uses the default boto3 session)
mgr = ExtensionManager()

# 2) Register whichever extensions you want:
ddb_config = DynamoDBConfig(
    max_retries=8,
    log_consumed=True,
    add_pagination=True,
    add_timestamps=True
)
mgr.register(DynamoDBExtension(ddb_config))

# 3) Bootstrap: from now on, boto3.client('dynamodb') is enhanced
mgr.bootstrap()

# Use the enhanced client
ddb = boto3.client('dynamodb')

# Insert item with native Python types (automatic serialization)
ddb.put_item(
    TableName='Users',
    Item={
        'UserId': 'alice',
        'Age': 30,
        'Active': True,
        'Data': {'joined': '2023-01-01'}
    }
)

# Use pagination helper
all_users = ddb.scan_all(TableName='Users')
print(all_users)  # All users with Python types

Features

Automatic Type Conversion

No more manual serialization between Python and DynamoDB types:

# Without botowrap
from boto3.dynamodb.types import TypeSerializer
serializer = TypeSerializer()
ddb.put_item(
    TableName='Users',
    Item={
        'UserId': serializer.serialize('alice'),
        'Age': serializer.serialize(30),
        'Active': serializer.serialize(True)
    }
)

# With botowrap
ddb.put_item(
    TableName='Users',
    Item={
        'UserId': 'alice',
        'Age': 30,
        'Active': True
    }
)

Automatic Timestamps

Keep track of when items were created and last modified:

# Creates an item with CreatedAt and UpdatedAt timestamps
ddb.put_item(TableName='Users', Item={'UserId': 'bob'})

# UpdatedAt is automatically updated, CreatedAt preserved
ddb.update_item(
    TableName='Users',
    Key={'UserId': 'bob'},
    UpdateExpression='SET Age = :a',
    ExpressionAttributeValues={':a': 25}
)

Simplified Pagination

No more dealing with LastEvaluatedKey tokens manually:

# With botowrap
all_items = ddb.scan_all(TableName='MyTable')

# Equivalent to:
items = []
resp = ddb.scan(TableName='MyTable')
items.extend(resp.get('Items', []))
while 'LastEvaluatedKey' in resp:
    resp = ddb.scan(
        TableName='MyTable',
        ExclusiveStartKey=resp['LastEvaluatedKey']
    )
    items.extend(resp.get('Items', []))

Configuration Options

The DynamoDB extension can be configured:

ddb_config = DynamoDBConfig(
    # Number of retries for throttling (default: 5)
    max_retries=8,

    # Whether to log consumed capacity (default: True)
    log_consumed=True,

    # Whether to add pagination helpers (default: True)
    add_pagination=True,

    # Whether to add CreatedAt/UpdatedAt timestamps (default: True)
    add_timestamps=True
)

Developing

• New service wrappers live under botowrap/extensions/
• Base classes and manager logic are in core.py
• Extensions must implement:
  • attach(session) - Adds functionality to the boto3 session
  • detach(session) - Removes functionality from the boto3 session

Creating an Extension

from botowrap.core import BaseExtension

class MyServiceExtension(BaseExtension):
    SERVICE = 'my-service'

    def __init__(self, config):
        self.config = config

    def attach(self, session):
        # Add functionality to the session
        pass

    def detach(self, session):
        # Remove functionality from the session
        pass

Documentation

For full documentation, visit the documentation site.

Contributing

Contributions are welcome! See the CONTRIBUTING guide for details.

License

This project is licensed under the MIT License - see the LICENSE file for details.