Metadata-Version: 2.1
Name: filterflow
Version: 0.1.0
Summary: A library to create data flow charts.
Author: Levi Waddingham
Requires-Python: >=3.7,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: plotly (>=4.14.3,<5.0.0)
Description-Content-Type: text/markdown

# filterflow

This package allows for the creation of funnel graphs
to quickly and easily display the length of a dataset
as a series of data processing steps are applied to it.

## Example usage

```
from filterflow import Flow, FlowElement

# Create list from 0 to 100
elements = range(100)

# Declare flow
f = Flow("Example with filtering numbers", len(elements))

# Filter out odd numbers
evens_only = [x for x in elements if x%2 == 0]
f.add_step("Removing odd numbers gives:", len(evens_only))

# Filter out numbers greater than 40
evens_less_than_40 = [x for x in elements if x < 40]
f.add_step("Removing numbers >= 40:", len(evens_less_than_40))

# Plot chart
f.plot()
```

!['Example image'](https://github.com/LeviWadd/filterflow/raw/master/images/example.JPG)
