pipelinewise-target-s3-csv

Singer target that uploads loads data to S3 in CSV format following the Singer spec.

This is a PipelineWise compatible target connector.

How to use it

The recommended method of running this target is to use it from PipelineWise. When running it from PipelineWise you don't need to configure this tap with JSON files and most of things are automated. Please check the related documentation at Target S3 CSV

If you want to run this Singer Target independently please read further.

Install

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

It's recommended to use a virtualenv:

  python3 -m venv venv
  pip install pipelinewise-target-s3-csv

or

  make venv

To run

Like any other target that's following the singer specification:

some-singer-tap | target-s3-csv --config [config.json]

It's reading incoming messages from STDIN and using the properties in config.json to upload data into Postgres.

Note: To avoid version conflicts run tap and targets in separate virtual environments.

Configuration settings

Running the target connector requires a config.json file. An example with the minimal settings:

{
  "s3_bucket": "my_bucket"
}

Profile based authentication

Profile based authentication used by default using the default profile. To use another profile set aws_profile parameter in config.json or set the AWS_PROFILE environment variable.

Non-Profile based authentication

For non-profile based authentication set aws_access_key_id , aws_secret_access_key and optionally the aws_session_token parameter in the config.json. Alternatively you can define them out of config.json by setting AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_SESSION_TOKEN environment variables.

Full list of options in config.json:

To run tests:

1. Define environment variables that requires running the tests

  export TARGET_S3_CSV_ACCESS_KEY_ID=<s3-access-key-id>
  export TARGET_S3_CSV_SECRET_ACCESS_KEY=<s3-secret-access-key>
  export TARGET_S3_CSV_BUCKET=<s3-bucket>
  export TARGET_S3_CSV_KEY_PREFIX=<s3-key-prefix>

2. Install python test dependencies in a virtual env and run unit and integration tests

    make venv

3. To run unit tests:

  make unit_test

4. To run integration tests:

  make integration_test

To run pylint:

1. Install python dependencies and run python linter

    make venv pylint

License

Apache License Version 2.0

See LICENSE to see the full text.