README.md

timeseries-shaper

Timeseries-Shaper is a Python library for efficiently filtering and preprocessing time series data using pandas. It provides a set of tools to handle various data transformations, making data preparation tasks easier and more intuitive.

Besides that multiple engineering specific methods are utilized to make it fast and easy to work with time series data.

Features | Structure

├── timeseries_shaper
│   ├── base.py
│   ├── calculator
│   │   └── numeric_calc.py
│   ├── cycles
│   │   ├── cycle_processor.py
│   │   └── cycles_extractor.py
│   ├── events
│   │   ├── outlier_detection.py
│   │   ├── statistical_process_control.py
│   │   ├── tolerance_deviation.py
│   │   └── value_mapping.py
│   ├── filter
│   │   ├── boolean_filter.py
│   │   ├── custom_filter.py
│   │   ├── datetime_filter.py
│   │   ├── numeric_filter.py
│   │   └── string_filter.py
│   ├── functions
│   │   └── lambda_func.py
│   ├── loader
│   │   ├── metadata
│   │   │   ├── metadata_api_loader.py
│   │   │   └── metadata_json_loader.py
│   │   └── timeseries
│   │       ├── parquet_loader.py
│   │       ├── s3proxy_parquet_loader.py
│   │       └── timescale_loader.py
│   ├── stats
│   │   ├── boolean_stats.py
│   │   ├── numeric_stats.py
│   │   ├── string_stats.py
│   │   └── timestamp_stats.py
│   ├── time_stats
│   │   └── time_stats_numeric.py

Installation

Install timeseries-shaper using pip:

pip install timeseries-shaper

Useage

Here is a quick example to get you started:

import pandas as pd
from timeseries_shaper.filters import IntegerFilter, StringFilter

# Sample DataFrame
data = {
    'value_integer': [1, 2, None, 4, 5],
    'value_string': ['apple', 'banana', None, 'cherry', 'date']
}
df = pd.DataFrame(data)

# Initialize the filter object
integer_filter = IntegerFilter(df)
string_filter = StringFilter(df)

# Apply filters
filtered_integers = integer_filter.filter_value_integer_not_match(2)
filtered_strings = string_filter.filter_value_string_not_match('banana')

print(filtered_integers)
print(filtered_strings)

Documentation

For full documentation, visit GitHub Pages or check out the docstrings in the code.

Contributing

Contributions are welcome! For major changes, please open an issue first to discuss what you would like to change.

Please ensure to update tests as appropriate.

License

Distributed under the MIT License. See LICENSE for more information.