Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

homeruntech/target-kinesis

Repository files navigation

target-kinesis

A Singer target that propagate data to Amazon Kinesis and Amazon Kinesis Data Firehose streams.

How to use it

target-kinesis works together with any other Singer Tap to move data from sources to Kinesis or Kinesis Firehose stream.

Install and Run

First, make sure Python 3 is installed on your system or follow these installation instructions for Mac or Ubuntu.

It's recommended to use a virtualenv:

 python3 -m venv ~/.virtualenvs/target-kinesis
 source ~/.virtualenvs/target-kinesis/bin/activate
 pip install -U pip setuptools
 pip install -e '.[dev]'

target-kinesis can be run with any Singer Tap, it simply propagate records encoded using the Singer format to a Kinesis or Kinesis Firehose stream.

Optional Configuration

target-kinesis requires configuration file that contains parameters to connect to AWS environment.

Here is an example of required configuration:

{
  "stream_name": "YOUR_KINESIS_STREAM_NAME",
  "aws_access_key_id": "YOUR_AWS_ACCESS_KEY_ID",
  "aws_secret_access_key": "YOUR_AWS_SECRET_ACCESS_KEY",
  "region": "YOUR_AWS_REGION",
  "is_firehose": true,
  "record_chunks": 10,
  "data_chunks": 1000
}

Also available inside config.sample.json

To run target-kinesis with the configuration file, use this command:

› tap-foobar | target-kinesis --config my-config.json

Run test suite

pytest -p no:warnings --cov=target_kinesis tests/test_target.py --cov-report=html