filter-pipe 1.0.0__tar.gz

filter_pipe-1.0.0/.devcontainer/Dockerfile

@@ -0,0 +1,4 @@
+FROM mcr.microsoft.com/vscode/devcontainers/base:ubuntu-24.04
+
+RUN sudo apt update && sudo apt upgrade -y
+RUN sudo apt install -y python3 python3-pip git gpg

filter_pipe-1.0.0/.devcontainer/devcontainer.json

@@ -0,0 +1,30 @@
+{
+    "name": "Devcontainer",
+    // "image": "",
+    "build": {
+        "context": "..",
+        "dockerfile": "Dockerfile"
+    },
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "ms-python.debugpy",
+                "ms-python.python",
+                "ms-python.vscode-pylance",
+                "ms-python.isort",
+                "ritwickdey.LiveServer"
+            ]
+        }
+    },
+    "mounts":[
+        "source=/tmp/.X11-unix,target=/tmp/.X11-unix,type=bind",
+        "source=${localEnv:HOME}/.ssh,target=/home/vscode/.ssh,type=bind,readonly",
+        "source=${localEnv:HOME}/.gitconfig,target=/home/vscode//.gitconfig,type=bind,readonly",
+    ],
+    "containerEnv": {
+    },
+    "runArgs": [
+    ],
+    "postCreateCommand": ".devcontainer/setup_devcontainer.sh",
+    "remoteUser": "vscode"
+}

filter_pipe-1.0.0/.devcontainer/setup_devcontainer.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+python3 -m pip install --break-system-packages -r requirements.txt
+
+pre-commit install
+pre-commit run

filter_pipe-1.0.0/.github/workflows/build.yaml

@@ -0,0 +1,27 @@
+name: Build and Release
+
+on:
+    push:
+        tags:
+            - "*"
+
+jobs:
+    deploy:
+        runs-on: ubuntu-latest
+        permissions:
+          id-token: write
+          contents: read
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                fetch-depth: 0
+            - name: Setup Python environment
+              uses: actions/setup-python@v5
+              with:
+                python-version: '3.x'
+            - run: python3 -m pip install -r requirements.txt
+            - name: Verify setuptools-scm detected version
+              run: python3 -m setuptools_scm
+            - run: python3 -m build
+            - name: Publish package to PyPi
+              uses: pypa/gh-action-pypi-publish@release/v1

filter_pipe-1.0.0/.github/workflows/ci.yaml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      # - run: |
+      #     sudo apt update
+      #     sudo apt upgrade -y
+      #     sudo apt install -y python3 python3-pip
+      - name: setup env
+        run: |
+          /bin/bash .devcontainer/setup_devcontainer.sh
+        env:
+          GITHUB_WORKSPACE: ${{ github.workspace }}
+      - name: run pre-commit
+        run: |
+          pre-commit run --all-files
+      - name: run tests
+        run:
+          python3 -m pytest

filter_pipe-1.0.0/.gitignore

@@ -0,0 +1,95 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+pip-wheel-metadata/
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+.venv/
+venv/
+ENV/
+env/
+env.bak/
+venv.bak/
+
+# venv
+*/bin/activate
+*/Lib/site-packages/
+*/pyvenv.cfg
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# pyre
+.pyre/
+
+# IDEs
+.vscode/
+.idea/
+*.sublime-project
+*.sublime-workspace

filter_pipe-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+exclude: src/jair_turtlesim/test/|src/jair_turtlesim/setup.py
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+        - id: trailing-whitespace
+        - id: end-of-file-fixer
+        - id: mixed-line-ending
+          args: [--fix=lf]
+        - id: check-yaml
+          args: [--unsafe]
+        - id: debug-statements
+        - id: double-quote-string-fixer
+        - id: requirements-txt-fixer
+        - id: check-added-large-files
+          args: ["--maxkb=512"]

filter_pipe-1.0.0/PKG-INFO

@@ -0,0 +1,191 @@
+Metadata-Version: 2.4
+Name: filter_pipe
+Version: 1.0.0
+Summary: Build and expose flexible calculation pipelines that give the end user total control over dynamic variables and data logic.
+Author: Jair
+Project-URL: Repository, https://github.com/Jair-F/filter_pipe
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# 🔗 filter_pipe
+
+A powerful and flexible Python library for building data processing pipelines with filters and mathematical operations. Chain multiple filters together to process numerical data in a clean, intuitive way.
+
+[![PyPI Version](https://img.shields.io/pypi/v/filter_pipe.svg)](https://pypi.org/project/filter_pipe/) [![Python Versions](https://img.shields.io/pypi/pyversions/filter_pipe.svg)](https://pypi.org/project/filter_pipe/)
+
+---
+
+## ✨ Features
+
+- ⛓️ **Chainable Pipelines** - Combine filters seamlessly using pipe syntax
+- 📊 **Signal Processing Filters** - Moving average, low-pass, high-pass, band-pass, notch filters
+- 🧮 **Mathematical Operations** - Add, subtract, multiply, divide operations
+- 🎯 **Flexible Configuration** - Easy-to-read pipeline syntax with customizable parameters
+- 🔍 **Regex-based Validation** - Robust pattern matching for pipeline chunks
+
+---
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+pip install -r requirements.txt
+```
+
+### Basic Usage
+
+```python
+from src.pipeline.pipeline import Pipeline
+
+# Create a pipeline with multiple filters
+pipeline = Pipeline('mavg(n=10) | lpass(alpha=0.2) | str(ndigits=2)')
+
+# Process a value through the pipeline
+result = pipeline.calc(2134.1231231)
+print(result)  # Output: '2064.17'
+```
+
+### Mathematical Operations
+
+```python
+from src.pipeline.math_ops import Divide, Multiply, Add
+
+# Use mathematical operations
+divider = Divide(' / 2')
+result = divider.calc(10)
+print(result)  # Output: 5.0
+
+# Combine in a pipeline
+pipeline = Pipeline('*2 | +5 | /3')
+result = pipeline.calc(10)  # (10 * 2 + 5) / 3 = 25/3 ≈ 8.33
+```
+
+### Advanced Pipeline Example
+
+```python
+# Signal smoothing pipeline: moving average → low-pass filter → round to 2 decimals
+pipeline = Pipeline('mavg(n=5) | lpass(alpha=0.3) | str(ndigits=2)')
+values = [100.2, 101.5, 99.8, 102.1, 100.9]
+
+for value in values:
+    smoothed = pipeline.calc(value)
+    print(f"Input: {value:6.1f} → Output: {smoothed}")
+```
+
+---
+
+## 📦 Available Pipeline Chunks
+
+### 🎯 Filters
+
+| Chunk | Syntax | Description | Parameters |
+|-------|--------|-------------|------------|
+| **Moving Average** | `mavg(n=N)` | Calculates the average of the last N values | `n` - window size (integer) |
+| **Low-Pass Filter** | `lpass(alpha=A)` | Smooths data by attenuating high frequencies | `alpha` - smoothing factor (0-1) |
+| **High-Pass Filter** | `hpass(alpha=A)` | Attenuates low frequencies, preserves high frequencies | `alpha` - smoothing factor (0-1) |
+| **Band-Pass Filter** | `bpass(low_alpha=A,high_alpha=B)` | Passes frequencies within a band | `low_alpha`, `high_alpha` - bounds (0-1) |
+| **Notch Filter** | `notch(low_alpha=A,high_alpha=B)` | Removes frequencies within a band | `low_alpha`, `high_alpha` - bounds (0-1) |
+| **High Cut** | `hcut(cut=C)` | Caps maximum value | `cut` - maximum threshold |
+| **Low Cut** | `lcut(cut=C)` | Caps minimum value | `cut` - minimum threshold |
+| **To String** | `str(ndigits=N)` | Converts to formatted string | `ndigits` - decimal places (optional, default=0) |
+
+### 🧮 Math Operations
+
+| Chunk | Syntax | Description | Parameters |
+|-------|--------|-------------|------------|
+| **Divide** | `/ D` | Divides value by D | `D` - divisor (number) |
+| **Multiply** | `* M` | Multiplies value by M | `M` - multiplier (number) |
+| **Add** | `+ V` | Adds V to value | `V` - value to add (number) |
+| **Subtract** | `- S` | Subtracts S from value | `S` - value to subtract (number) |
+
+---
+
+## 💡 Examples
+
+### Example 1: Temperature Smoothing
+Smooth noisy temperature sensor readings:
+
+```python
+from src.pipeline.pipeline import Pipeline
+
+# Combine moving average with low-pass filter
+pipeline = Pipeline('mavg(n=3) | lpass(alpha=0.5) | str(ndigits=1)')
+
+temperatures = [20.1, 25.3, 19.8, 21.2, 20.9]
+for temp in temperatures:
+    smoothed = pipeline.calc(temp)
+    print(f"Temperature: {temp}°C → Smoothed: {smoothed}°C")
+```
+
+### Example 2: Financial Data Processing
+Process stock price data:
+
+```python
+# 10-period moving average → normalize → round to 2 decimals
+pipeline = Pipeline('mavg(n=10) | str(ndigits=2)')
+
+stock_prices = [150.25, 149.80, 151.10, 150.95, 149.50]
+for price in stock_prices:
+    avg = pipeline.calc(price)
+    print(f"${price} → MA: ${avg}")
+```
+
+### Example 3: Signal Processing
+Apply advanced filtering:
+
+```python
+# Remove noise with band-pass → apply notch → convert to string
+pipeline = Pipeline('bpass(low_alpha=0.2,high_alpha=0.8) | notch(low_alpha=0.3,high_alpha=0.7) | str(ndigits=3)')
+
+signal_data = [0.5, 0.6, 0.55, 0.58, 0.52]
+for signal in signal_data:
+    filtered = pipeline.calc(signal)
+    print(f"Signal: {signal} → Filtered: {filtered}")
+```
+
+### Example 4: Value Constraints
+Bound values within a range:
+
+```python
+# Scale value, then apply min/max constraints
+pipeline = Pipeline('*10 | lcut(cut=0) | hcut(cut=100)')
+
+raw_values = [-1.5, 5.3, 12.8, -0.2]
+for val in raw_values:
+    bounded = pipeline.calc(val)
+    print(f"{val} → {bounded} (0-100 range)")
+```
+
+---
+
+## 🧪 Running Tests
+
+Execute the test suite to verify functionality:
+
+```bash
+python3 -m pytest
+```
+
+Tests are located in the `tests/` directory:
+- `test_filters.py` - Filter functionality tests
+- `test_math.py` - Math operations tests
+- `test_pipeline.py` - Pipeline chaining tests
+
+---
+
+## 🔗 Resources
+
+- **📦 PyPI Package**: Find this project on [PyPI](https://pypi.org/project/filter_pipe/)
+- **�💼 Regex Patterns**: Learn and test regex patterns used in this project at [regex101.com](https://regex101.com/)
+- **📚 Tools**: See `tools/index.html` for playing around with the filters and learn how to calibrate the gains.
+
+---
+
+## 📝 License
+
+This project is open-source and available for educational and commercial use.
+
+---
+
+**Built with ❤️ for data processing pipelines**

filter_pipe-1.0.0/README.md

@@ -0,0 +1,182 @@
+# 🔗 filter_pipe
+
+A powerful and flexible Python library for building data processing pipelines with filters and mathematical operations. Chain multiple filters together to process numerical data in a clean, intuitive way.
+
+[![PyPI Version](https://img.shields.io/pypi/v/filter_pipe.svg)](https://pypi.org/project/filter_pipe/) [![Python Versions](https://img.shields.io/pypi/pyversions/filter_pipe.svg)](https://pypi.org/project/filter_pipe/)
+
+---
+
+## ✨ Features
+
+- ⛓️ **Chainable Pipelines** - Combine filters seamlessly using pipe syntax
+- 📊 **Signal Processing Filters** - Moving average, low-pass, high-pass, band-pass, notch filters
+- 🧮 **Mathematical Operations** - Add, subtract, multiply, divide operations
+- 🎯 **Flexible Configuration** - Easy-to-read pipeline syntax with customizable parameters
+- 🔍 **Regex-based Validation** - Robust pattern matching for pipeline chunks
+
+---
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+pip install -r requirements.txt
+```
+
+### Basic Usage
+
+```python
+from src.pipeline.pipeline import Pipeline
+
+# Create a pipeline with multiple filters
+pipeline = Pipeline('mavg(n=10) | lpass(alpha=0.2) | str(ndigits=2)')
+
+# Process a value through the pipeline
+result = pipeline.calc(2134.1231231)
+print(result)  # Output: '2064.17'
+```
+
+### Mathematical Operations
+
+```python
+from src.pipeline.math_ops import Divide, Multiply, Add
+
+# Use mathematical operations
+divider = Divide(' / 2')
+result = divider.calc(10)
+print(result)  # Output: 5.0
+
+# Combine in a pipeline
+pipeline = Pipeline('*2 | +5 | /3')
+result = pipeline.calc(10)  # (10 * 2 + 5) / 3 = 25/3 ≈ 8.33
+```
+
+### Advanced Pipeline Example
+
+```python
+# Signal smoothing pipeline: moving average → low-pass filter → round to 2 decimals
+pipeline = Pipeline('mavg(n=5) | lpass(alpha=0.3) | str(ndigits=2)')
+values = [100.2, 101.5, 99.8, 102.1, 100.9]
+
+for value in values:
+    smoothed = pipeline.calc(value)
+    print(f"Input: {value:6.1f} → Output: {smoothed}")
+```
+
+---
+
+## 📦 Available Pipeline Chunks
+
+### 🎯 Filters
+
+| Chunk | Syntax | Description | Parameters |
+|-------|--------|-------------|------------|
+| **Moving Average** | `mavg(n=N)` | Calculates the average of the last N values | `n` - window size (integer) |
+| **Low-Pass Filter** | `lpass(alpha=A)` | Smooths data by attenuating high frequencies | `alpha` - smoothing factor (0-1) |
+| **High-Pass Filter** | `hpass(alpha=A)` | Attenuates low frequencies, preserves high frequencies | `alpha` - smoothing factor (0-1) |
+| **Band-Pass Filter** | `bpass(low_alpha=A,high_alpha=B)` | Passes frequencies within a band | `low_alpha`, `high_alpha` - bounds (0-1) |
+| **Notch Filter** | `notch(low_alpha=A,high_alpha=B)` | Removes frequencies within a band | `low_alpha`, `high_alpha` - bounds (0-1) |
+| **High Cut** | `hcut(cut=C)` | Caps maximum value | `cut` - maximum threshold |
+| **Low Cut** | `lcut(cut=C)` | Caps minimum value | `cut` - minimum threshold |
+| **To String** | `str(ndigits=N)` | Converts to formatted string | `ndigits` - decimal places (optional, default=0) |
+
+### 🧮 Math Operations
+
+| Chunk | Syntax | Description | Parameters |
+|-------|--------|-------------|------------|
+| **Divide** | `/ D` | Divides value by D | `D` - divisor (number) |
+| **Multiply** | `* M` | Multiplies value by M | `M` - multiplier (number) |
+| **Add** | `+ V` | Adds V to value | `V` - value to add (number) |
+| **Subtract** | `- S` | Subtracts S from value | `S` - value to subtract (number) |
+
+---
+
+## 💡 Examples
+
+### Example 1: Temperature Smoothing
+Smooth noisy temperature sensor readings:
+
+```python
+from src.pipeline.pipeline import Pipeline
+
+# Combine moving average with low-pass filter
+pipeline = Pipeline('mavg(n=3) | lpass(alpha=0.5) | str(ndigits=1)')
+
+temperatures = [20.1, 25.3, 19.8, 21.2, 20.9]
+for temp in temperatures:
+    smoothed = pipeline.calc(temp)
+    print(f"Temperature: {temp}°C → Smoothed: {smoothed}°C")
+```
+
+### Example 2: Financial Data Processing
+Process stock price data:
+
+```python
+# 10-period moving average → normalize → round to 2 decimals
+pipeline = Pipeline('mavg(n=10) | str(ndigits=2)')
+
+stock_prices = [150.25, 149.80, 151.10, 150.95, 149.50]
+for price in stock_prices:
+    avg = pipeline.calc(price)
+    print(f"${price} → MA: ${avg}")
+```
+
+### Example 3: Signal Processing
+Apply advanced filtering:
+
+```python
+# Remove noise with band-pass → apply notch → convert to string
+pipeline = Pipeline('bpass(low_alpha=0.2,high_alpha=0.8) | notch(low_alpha=0.3,high_alpha=0.7) | str(ndigits=3)')
+
+signal_data = [0.5, 0.6, 0.55, 0.58, 0.52]
+for signal in signal_data:
+    filtered = pipeline.calc(signal)
+    print(f"Signal: {signal} → Filtered: {filtered}")
+```
+
+### Example 4: Value Constraints
+Bound values within a range:
+
+```python
+# Scale value, then apply min/max constraints
+pipeline = Pipeline('*10 | lcut(cut=0) | hcut(cut=100)')
+
+raw_values = [-1.5, 5.3, 12.8, -0.2]
+for val in raw_values:
+    bounded = pipeline.calc(val)
+    print(f"{val} → {bounded} (0-100 range)")
+```
+
+---
+
+## 🧪 Running Tests
+
+Execute the test suite to verify functionality:
+
+```bash
+python3 -m pytest
+```
+
+Tests are located in the `tests/` directory:
+- `test_filters.py` - Filter functionality tests
+- `test_math.py` - Math operations tests
+- `test_pipeline.py` - Pipeline chaining tests
+
+---
+
+## 🔗 Resources
+
+- **📦 PyPI Package**: Find this project on [PyPI](https://pypi.org/project/filter_pipe/)
+- **�💼 Regex Patterns**: Learn and test regex patterns used in this project at [regex101.com](https://regex101.com/)
+- **📚 Tools**: See `tools/index.html` for playing around with the filters and learn how to calibrate the gains.
+
+---
+
+## 📝 License
+
+This project is open-source and available for educational and commercial use.
+
+---
+
+**Built with ❤️ for data processing pipelines**

filter_pipe-1.0.0/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["setuptools>=61.0", "setuptools-scm>=7.0", "twine", "build"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "filter_pipe"
+dynamic = ["version"]
+readme = "README.md"
+authors = [
+    {name = "Jair"},
+]
+description = "Build and expose flexible calculation pipelines that give the end user total control over dynamic variables and data logic."
+requires-python = ">=3.8"
+dependencies = []
+
+[project.urls]
+Repository = "https://github.com/Jair-F/filter_pipe"
+
+[tool.setuptools_scm]
+# You can leave this table empty; setuptools-scm uses smart defaults.
+# It automatically detects the version from your Git tags.

filter_pipe-1.0.0/requirements.txt

@@ -0,0 +1,4 @@
+build
+pre-commit
+pytest
+setuptools-scm

filter_pipe-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

filter_pipe-1.0.0/src/app.py

@@ -0,0 +1,13 @@
+from src.pipeline.math_ops import Divide
+from src.pipeline.pipeline import Pipeline
+
+
+if __name__ == '__main__':
+    pipeline = Pipeline(' mavg(n=10) | lpass(alpha=0.2) | str(ndigits=2)')
+    print(F"pipeline: {pipeline.calc(2134.1231231)}")
+
+    divider = Divide(' / 2')
+    print(F"10/div: {divider.calc(10)}")
+
+    print(F"value: {str(float(round(123.123, ndigits=2)))}")
+    print(F"value: {str(123)}")