Metadata-Version: 1.1
Name: kinesisutils
Version: 0.0.2
Summary: Kinesis utilities
Home-page: https://github.com/findhotel/kinesisutils
Author: German Gomez-Herrero
Author-email: german@findhotel.net
License: MIT
Description: Kinesis utilities
        =================
        
        |PyPI|
        
        Miscellaneous utilities for `AWS
        Kinesis <https://aws.amazon.com/kinesis/streams/>`__.
        
        Installation
        ------------
        
        ::
        
            pip install kinesisutils
        
        To install the development version:
        
        ::
        
            pip install git+https://github.com/findhotel/kinesisutils
        
        Usage
        -----
        
        At the moment there is only one utility implemented: a Python generator
        that reads records from a Kinesis stream. You can use it like this:
        
        ::
        
            import json
        
            from kinesisutils import KinesisGenerator
        
            # Hit Kinesis with at most 10 requests per second, usin json.loads to
            # deserialize the Kinesis records (the default). You could deactivate record
            # deserialization by setting des=None.
            kg = KinesisGenerator("stream_name", rqs=10, des=json.loads)
        
            for rec in kg:
                print(rec)
        
        By default the generator will keep pulling records from Kinesis for 60
        seconds. You can customize this timeout if you want:
        
        ::
        
            from kinesisutils import KinesisGenerator
        
            kg = KinesisGenerator("stream_name", timeout=30)
        
            for rec in kg:
                print(rec)
        
        Contact
        -------
        
        If you have questions, bug reports, suggestions, etc. please create an
        issue on the `GitHub project
        page <http://github.com/findhotel/kinesisutils>`__. PRs are also
        welcome.
        
        License
        -------
        
        This software is licensed under the `MIT
        license <http://en.wikipedia.org/wiki/MIT_License>`__.
        
        See `License
        file <https://github.com/findhotel/kinesisutils/blob/master/LICENSE.txt>`__.
        
        © 2017 German Gomez-Herrero, `Find
        Hotel <http://company.findhotel.net>`__ and others.
        
        .. |PyPI| image:: https://img.shields.io/pypi/v/kinesisutils.svg?style=flat
           :target: https://pypi.python.org/pypi/kinesisutils
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
