Skip to content

baikonur-oss/amazon-kinesis-utils

Repository files navigation

amazon-kinesis-utils

A library of useful utilities for Amazon Kinesis

PyPi version t Code style: black Language grade: Python

CircleCI codecov Updates Documentation Status

Reference

See: https://amazon-kinesis-utils.readthedocs.io/en/latest/

Usage

# import submodule you want to use with from import
from amazon_kinesis_utils import kinesis

def lambda_handler(event, context):
    raw_records = event['Records']
    
    # kinesis.parse_records parses aggregated/non-aggregated records, with or without gzip compression
    # it even unpacks CloudWatch Logs subscription filters messages
    for payload in kinesis.parse_records(raw_records):
        # kinesis.parse_records is a generator, so we only have one payload in memory on every iteration
        print(f"Decoded payload: {payload}")

Contributing

Make sure to have following tools installed:

macOS

$ brew install pre-commit

# set up pre-commit hooks by running below command in repository root
$ pre-commit install

# install sphinx
$ pip install sphinx sphinx_rtd_theme