pipe-flow

README

pipe-flow

A data processing library that allows the creation of parallel pipelines that end in a common point.

Build status

Flow diagram

Source

A data source that holds data that will be passed through pipelines. For now, it is limited to taking in a CSV formatted file. The CSV is read and a pipeline is created for each column. The user is responsible for creating the function that runs on a specific column of the CSV file.

Pipe

The structure through which data flows. The pipeline applies the specified user function to either all the data points independently or perform an aggregation of all the data points to create a common summary. Data passes straight through the pipeline and offers the option to report progress as data is processed.

Sink

The sink is a data repository that aggregates all the data that pipeline operations were performed on and creates a new CSV file that holds the results. The results may not be structured the same way as the input CSV is because of the different pipeline functions that can be created. For example, a CSV column may end with a summary statistic while another may end with independently modified values.

Structure

A concept that holds and coordinates calls to flow data through pipes, and make the sink dump its data once everything is done.

Code examples

See main.go for an example.

Test and build

Run:

# build the project files
go build .
# test all the files of the project, including sub-directories
go test ./...

TODO

1. Make pipes run in parallel
2. Add pipe ability to report progress
3. Make structure allow the user specify whether to inform progress or not
4. Other TODOs left in the code