humilis-kinesis-processor 1.3.7
Humilis kinesis stream processor plugin
License: MIT

Kinesis event stream processor
===================================

.. |Build Status| image:: https://travis-ci.org/humilis/humilis-kinesis-processor.svg?branch=master
   :target: https://travis-ci.org/humilis/humilis-kinesis-processor
.. |PyPI| image:: https://img.shields.io/pypi/v/humilis-kinesis-processor.svg?style=flat
   :target: https://pypi.python.org/pypi/humilis-kinesis-processor

|Build Status| |PyPI|

A `humilis <https://github.com/humilis/humilis>`__ plugin to deploy a
`Lambda <https://aws.amazon.com/documentation/lambda/>`__ function that
maps events in a `Kinesis <https://aws.amazon.com/documentation/kinesis/>`__
event stream using a list of Python callables.

Installation
------------

::

    pip install humilis-kinesis-processor

Development
-----------

Assuming you have
`virtualenv <https://virtualenv.readthedocs.org/en/latest/>`__ installed:

::

    make develop

Configure humilis::

    .env/bin/humilis configure --local

Testing
-------

Unit tests
~~~~~~~~~~

To run the local test suite::

    make test


Integration tests
~~~~~~~~~~~~~~~~~

Before running the integration test suite you need to set a few deployment 
secrets using the command::

    s3keyring set [group]/[STAGE] [key] [secret]


In group ``humilis-kinesis-processor`` the following secrets need to be set:

* ``sentry/dsn``: The `Sentry DSN <https://docs.getsentry.com/hosted/quickstart/#configure-the-dsn>`__.


By the default, the integration tests will deploy on a stage called ``DEV`` so
the command to set the Sentry DSN is::

    s3keyring set humilis-kinesis-processor:DEV sentry.dsn [SENTRYDSN]


To run the integration test suite::

    make testi

The command above will deploy a Kinesis processor to your AWS account, and will
also create additional resources (such as several Kinesis streams) needed to
test that the deployment was successful. Once deployed, the integration tests
will run, and once they have completed the test environment will be destroyed.

If you do not want the test environment to be destroyed after tests have 
completed you should run instead::

   make testi DESTROY=no

You can also modify the name of the deployment stage by setting the ``STAGE``
environment variable. For instance, to deploy to a ``TEST`` stage::

   make testi STAGE=TEST



More information
----------------

See `humilis <https://github.com/humilis/humilis>`__ documentation.


Contact
-------

If you have questions, bug reports, suggestions, etc. please create an issue on
the `GitHub project page <http://github.com/humilis/humilis-kinesis-processor>`_.

License
-------

This software is licensed under the `MIT license <http://en.wikipedia.org/wiki/MIT_License>`_

See `License file <https://github.com/humilis/humilis-kinesis-processor/blob/master/LICENSE.txt>`_


© 2016 Anatoly Bubenkov, German Gomez-Herrero, `FindHotel <http://company.findhotel.net>`_ and others.

Authors
=======

`Anatoly Bubenkov <bubenkoff@gmail.com>`_
    initial idea and first alpha implementation
`German Gomez-Herrero <german.gomezherrero@gmail.com>`_
    actual implementation and further developments

Changelog
=========

0.9.7
-----

- Support for Lambda environment variables

0.9.6
-----

- Do not silence exception if Kinesis payload is not a json object

0.9.5
-----

- Support for delivery streams filters and mappers

0.9.0
-----

- Better debugging of processing errors

0.8.9
-----

- Add error annotations to events that failed to be processed

0.8.6
-----

- Bugfix in error handling logic.

0.8.5
-----

- Better error handling.

0.7.7
-----

- Support for multiple delivery streams for input, error, and output(s)

0.7.6
-----

- Support for one-to-many mappers

0.7.5
-----

- Users can also specify input/output/error streams by name instead of as
  references to another layer outputs.

0.6.8
-----

- Set environment variables for the humilis environment/layer/stage

0.4.0
-----

- Major bugfix: permission to put records in delivery streams

0.3.0
-----

- Major bugfix: give permission to write state to DynamodDB

0.2.0
-----

- Package becomes a generic map-multiplex-map processor (germangh)

0.1.1
-----

- Cleanup package data (bubenkoff)

0.1.0
-----

- Major refactoring to simplify and clean the code (germangh)

0.0.1
-----

- Initial release (bubenkoff)