Metadata-Version: 2.1
Name: amazon-kinesis-utils
Version: 0.1.2
Summary: amazon-kinesis-utils: a library of useful utilities for Amazon Kinesis
Home-page: https://amazon-kinesis-utils.readthedocs.io/en/latest/
Author: Tamirlan Torgayev
Author-email: torgayev@me.com
License: MIT
Project-URL: Source Code, https://github.com/baikonur-oss/amazon-kinesis-utils
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
Requires-Dist: python-dateutil
Requires-Dist: aws-kinesis-agg

# amazon-kinesis-utils
amazon-kinesis-utils: a library of useful utilities for Amazon Kinesis

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![PyPi version](https://img.shields.io/pypi/v/amazon-kinesis-utils.svg)](https://pypi.python.org/pypi/amazon-kinesis-utils/) 
![](https://img.shields.io/badge/python-3.6+-blue.svg) 
![t](https://img.shields.io/badge/status-beta-orange.svg) 

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

## Usage
```python
# 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
    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:
- [pre-commit](https://pre-commit.com/)
- Sphinx for docs generation

### macOS
```console
$ 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
```


