transude 1.1.6

Simple tool set for filtering DataFrames by building queries from one or more filters.

Transude

Simple tool set for filtering DataFrames (Pandas or Polars*) by building queries from one or more filters. This is useful for connecting filtering controls on DataFrames using touch screen controls.

This project was developed with some consulting from ChatGPT. There were a few concepts I didn't understand until I had someone I could point more specific questions towards and see working examples. Most of the scaffolding was written before consulting as it really tends to speed up responses and keep the conversation on track. This is also a refactor of old code I used in a recent project.

Installation:

pip install transude

Usage:

import pandas as pd
import transude as txd

# Create a DataFrame using Pandas
pd_df = pd.DataFrame(...)

# Get a filtered version of the DataFrame using Transude
filtered_pd_df = txd.filter_df(data_frame=pd_df, columns='col1', values=['val1', 'val2'], operator='==', joiner='or')

If you need to manage the DataFrameFilters directly, you can use a DataFrameFilterManager like so:

pd_df_filter_manager = DataFrameFilterManager()

# Example of adding a single DataFrameFilter and clearing the filters.  Filters can be removed one by one as well.
pd_df_filter_manager.add_filter(DataFrameFilter(columns='col1', values='val1', operator='==', joiner='or'))
pd_df_filter_manager.clear_filters()

# The following utilizes the DataFrameFilterFactory to create multiple filters and then adds them all to the builder.
pd_filter_factory = DataFrameFilterFactory(columns='col1', values=['val1', 'val2'], operator='==', joiner='or')
pd_filters = pd_filter_factory.create_filters()
pd_df_filter_manager.add_filters(pd_filters)
query_string = pd_df_filter_manager.build_query()

# In order to apply the filters, call query using the query_string
pd_df.query(query_string)

--*Polars compatability coming soon.