ezmsg-baseproc 1.0__tar.gz

ezmsg_baseproc-1.0/.github/workflows/docs.yml

@@ -0,0 +1,66 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*'
+  pull_request:
+    branches:
+      - main
+      - dev
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Needed for hatch-vcs to determine version
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          python-version: "3.12"
+
+      - name: Install the project
+        run: uv sync --only-group docs
+
+      - name: Build documentation
+        run: |
+          cd docs
+          uv run make html
+
+      - name: Add .nojekyll file
+        run: touch docs/build/html/.nojekyll
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'docs/build/html'
+
+  deploy:
+    # Only deploy on push to main or release tags
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v'))
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

ezmsg_baseproc-1.0/.github/workflows/python-publish.yml

@@ -0,0 +1,28 @@
+# This workflow will upload a Python Package using Twine when a release is created
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: build and upload release to PyPI
+    runs-on: ubuntu-latest
+    environment: "release"
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Build Package
+        run: uv build
+
+      - name: Publish package distributions to PyPI
+        run: uv publish

ezmsg_baseproc-1.0/.github/workflows/python-tests.yml

@@ -0,0 +1,36 @@
+name: Test package
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches:
+      - main
+      - dev
+  workflow_dispatch:
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        python-version: ["3.10.15", "3.11", "3.12", "3.13"]
+        os:
+          - "ubuntu-latest"
+          - "windows-latest"
+          - "macos-latest"
+    runs-on: ${{matrix.os}}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install the project
+        run: uv sync --python ${{ matrix.python-version }}
+
+      - name: Lint
+        run: uv tool run ruff check --output-format=github src
+
+      - name: Run tests
+        run: uv run pytest tests

ezmsg_baseproc-1.0/.gitignore

@@ -0,0 +1,129 @@
+# 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/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Sphinx documentation
+docs/_build/
+docs/build/
+docs/source/_build
+docs/source/generated
+docs/source/api/generated
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+# .python-version
+
+# PEP 582
+__pypackages__/
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# JetBrains IDE
+.idea/
+
+# VS Code
+.vscode/
+
+# Ruff cache
+.ruff_cache/
+
+# hatch-vcs generated version file
+src/ezmsg/baseproc/__version__.py
+
+# uv lockfile (optional - comment if you want to track it)
+uv.lock
+
+# Claude
+settings.local.json

ezmsg_baseproc-1.0/.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.3
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format

ezmsg_baseproc-1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ezmsg-org
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ezmsg_baseproc-1.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: ezmsg-baseproc
+Version: 1.0
+Summary: Base processor classes and protocols for ezmsg signal processing pipelines
+Author-email: Griffin Milsap <griffin.milsap@gmail.com>, Preston Peranich <pperanich@gmail.com>, Chadwick Boulay <chadwick.boulay@gmail.com>, Kyle McGraw <kmcgraw@blackrockneuro.com>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: ezmsg[axisarray]>=3.6.0
+Requires-Dist: typing-extensions>=4.0.0
+Description-Content-Type: text/markdown
+
+# ezmsg-baseproc
+
+Base processor classes and protocols for building signal processing pipelines in [ezmsg](https://github.com/ezmsg-org/ezmsg).
+
+## Installation
+
+```bash
+pip install ezmsg-baseproc
+```
+
+## Overview
+
+This package provides the foundational processor architecture for ezmsg signal processing:
+
+- **Protocols** - Type definitions for processors, transformers, consumers, and producers
+- **Base Classes** - Abstract base classes for building stateless and stateful processors
+- **Composite Processors** - Classes for chaining processors into pipelines
+- **Unit Wrappers** - ezmsg Unit base classes that wrap processors for graph integration
+
+## Module Structure
+
+```
+ezmsg.baseproc/
+├── protocols.py      # Protocol definitions and type variables
+├── processor.py      # Base non-stateful processors
+├── stateful.py       # Stateful processor base classes
+├── composite.py      # CompositeProcessor and CompositeProducer
+├── units.py          # ezmsg Unit wrappers
+└── util/
+    ├── asio.py           # Async/sync utilities
+    ├── message.py        # SampleMessage definitions
+    ├── profile.py        # Profiling decorators
+    └── typeresolution.py # Type resolution helpers
+```
+
+## Usage
+
+### Creating a Simple Transformer
+
+```python
+from dataclasses import dataclass
+from ezmsg.baseproc import BaseTransformer
+from ezmsg.util.messages.axisarray import AxisArray
+
+@dataclass
+class MySettings:
+    scale: float = 1.0
+
+class MyTransformer(BaseTransformer[MySettings, AxisArray, AxisArray]):
+    def _process(self, message: AxisArray) -> AxisArray:
+        return message.replace(data=message.data * self.settings.scale)
+```
+
+### Creating a Stateful Transformer
+
+```python
+from ezmsg.baseproc import BaseStatefulTransformer, processor_state
+
+@processor_state
+class MyState:
+    count: int = 0
+    hash: int = -1
+
+class MyStatefulTransformer(BaseStatefulTransformer[MySettings, AxisArray, AxisArray, MyState]):
+    def _reset_state(self, message: AxisArray) -> None:
+        self._state.count = 0
+
+    def _process(self, message: AxisArray) -> AxisArray:
+        self._state.count += 1
+        return message
+```
+
+### Creating an ezmsg Unit
+
+```python
+from ezmsg.baseproc import BaseTransformerUnit
+
+class MyUnit(BaseTransformerUnit[MySettings, AxisArray, AxisArray, MyTransformer]):
+    SETTINGS = MySettings
+    # That's all - the base class handles everything else!
+```
+
+## Development
+
+We use [`uv`](https://docs.astral.sh/uv/getting-started/installation/) for development.
+
+1. Install `uv` if not already installed
+2. Clone and cd into the repository
+3. Run `uv sync` to create a `.venv` and install dependencies
+4. Run `uv run pytest tests` to run tests
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

ezmsg_baseproc-1.0/README.md

@@ -0,0 +1,94 @@
+# ezmsg-baseproc
+
+Base processor classes and protocols for building signal processing pipelines in [ezmsg](https://github.com/ezmsg-org/ezmsg).
+
+## Installation
+
+```bash
+pip install ezmsg-baseproc
+```
+
+## Overview
+
+This package provides the foundational processor architecture for ezmsg signal processing:
+
+- **Protocols** - Type definitions for processors, transformers, consumers, and producers
+- **Base Classes** - Abstract base classes for building stateless and stateful processors
+- **Composite Processors** - Classes for chaining processors into pipelines
+- **Unit Wrappers** - ezmsg Unit base classes that wrap processors for graph integration
+
+## Module Structure
+
+```
+ezmsg.baseproc/
+├── protocols.py      # Protocol definitions and type variables
+├── processor.py      # Base non-stateful processors
+├── stateful.py       # Stateful processor base classes
+├── composite.py      # CompositeProcessor and CompositeProducer
+├── units.py          # ezmsg Unit wrappers
+└── util/
+    ├── asio.py           # Async/sync utilities
+    ├── message.py        # SampleMessage definitions
+    ├── profile.py        # Profiling decorators
+    └── typeresolution.py # Type resolution helpers
+```
+
+## Usage
+
+### Creating a Simple Transformer
+
+```python
+from dataclasses import dataclass
+from ezmsg.baseproc import BaseTransformer
+from ezmsg.util.messages.axisarray import AxisArray
+
+@dataclass
+class MySettings:
+    scale: float = 1.0
+
+class MyTransformer(BaseTransformer[MySettings, AxisArray, AxisArray]):
+    def _process(self, message: AxisArray) -> AxisArray:
+        return message.replace(data=message.data * self.settings.scale)
+```
+
+### Creating a Stateful Transformer
+
+```python
+from ezmsg.baseproc import BaseStatefulTransformer, processor_state
+
+@processor_state
+class MyState:
+    count: int = 0
+    hash: int = -1
+
+class MyStatefulTransformer(BaseStatefulTransformer[MySettings, AxisArray, AxisArray, MyState]):
+    def _reset_state(self, message: AxisArray) -> None:
+        self._state.count = 0
+
+    def _process(self, message: AxisArray) -> AxisArray:
+        self._state.count += 1
+        return message
+```
+
+### Creating an ezmsg Unit
+
+```python
+from ezmsg.baseproc import BaseTransformerUnit
+
+class MyUnit(BaseTransformerUnit[MySettings, AxisArray, AxisArray, MyTransformer]):
+    SETTINGS = MySettings
+    # That's all - the base class handles everything else!
+```
+
+## Development
+
+We use [`uv`](https://docs.astral.sh/uv/getting-started/installation/) for development.
+
+1. Install `uv` if not already installed
+2. Clone and cd into the repository
+3. Run `uv sync` to create a `.venv` and install dependencies
+4. Run `uv run pytest tests` to run tests
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

ezmsg_baseproc-1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

ezmsg_baseproc-1.0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

ezmsg_baseproc-1.0/docs/source/_templates/autosummary/module.rst

@@ -0,0 +1,64 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+      :toctree:
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: Functions
+
+   {% for item in functions %}
+   .. autofunction:: {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: Classes
+
+   {% for item in classes %}
+   .. autoclass:: {{ item }}
+      :members:
+      :undoc-members:
+      :show-inheritance:
+      :special-members: __init__
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: Exceptions
+
+   {% for item in exceptions %}
+   .. autoexception:: {{ item }}
+      :members:
+      :show-inheritance:
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}

ezmsg_baseproc-1.0/docs/source/api/index.rst

@@ -0,0 +1,8 @@
+API Reference
+=============
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   ezmsg.baseproc