walsh 0.1.1__tar.gz

walsh-0.1.1/CHANGELOG.md

@@ -0,0 +1,70 @@
+# Changelog
+
+All notable changes to this project are documented here.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+The `## [x.y.z]` headings are load-bearing: the release workflow extracts the
+section matching the version in `pyproject.toml` and uses it as the GitHub
+Release notes.
+
+## [0.1.1]
+
+### Added
+
+- `uv` support: a `uv.lock` committed to the repository, and a `dev`
+  [PEP 735](https://peps.python.org/pep-0735/) dependency group, so
+  `uv sync --group dev` reproduces the full development environment.
+- Release automation. A version bump landing on `master` tags `v<version>`,
+  creates a GitHub Release with these notes attached, and publishes the sdist
+  and wheel to [PyPI](https://pypi.org/project/walsh/) via Trusted Publishing.
+- CI on every pull request: ruff, `ruff format --check`, strict mypy, the test
+  suite on Python 3.10 through 3.14, and a packaging job that builds both
+  distributions and smoke-tests the wheel in a clean environment.
+- Python 3.14 to the supported classifiers.
+- `Issues` and `Changelog` project URLs.
+
+### Changed
+
+- The `dev` extra became the `dev` dependency group. `pip install .[dev]` no
+  longer works; use `uv sync --group dev`, `pip install --group dev .`
+  (pip 25.1+), or `pip install -r requirements-dev.txt`.
+
+## [0.1.0]
+
+### Added
+
+- `walsh` console script with `compress` and `extract` subcommands.
+- Test suite covering the transform, colour models, both container formats, the
+  task pipelines and the CLI.
+- Type annotations throughout, with a `py.typed` marker; clean under
+  `mypy --strict`.
+
+### Changed
+
+- Ported from Python 2.7 to Python 3.10+ and restructured as an installable
+  package under `src/walsh`. The old `fal` package and root `transform.py` were
+  removed; the demo moved to `examples/roundtrip.py`.
+- `numpy` is now the only runtime dependency. `matplotlib` and `Pillow` were
+  only ever used by the demo script and became the `demo` extra.
+- Spectral coefficients are rounded with `np.rint` on write. Python 2 relied on
+  `struct.pack` implicitly truncating floats, so output differs from the
+  pre-port result by at most 2 per channel (mean 0.33).
+- `np.matrix` replaced with `ndarray` and the `@` operator.
+- Requirements files carry explicit version bounds.
+
+### Known issues
+
+Both predate the port and are preserved deliberately, because changing either
+alters every compressed output:
+
+- `BMPImage` reads pixel triples in BMP's native B, G, R order while `Task`
+  treats them as R, G, B. Round trips are exact, but the YCbCr weights land on
+  swapped channels.
+- The `coeff_removal` comparison is one-sided rather than on the magnitude, so
+  any non-`None` coefficient above `-1/sqrt(2)**n` zeroes essentially the whole
+  spectrum.
+
+[0.1.1]: https://github.com/oskar-j/walsh-hadamard-transform/releases/tag/v0.1.1
+[0.1.0]: https://github.com/oskar-j/walsh-hadamard-transform/releases/tag/v0.1.0

walsh-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Oskar Jarczyk
+
+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.

walsh-0.1.1/MANIFEST.in

@@ -0,0 +1,14 @@
+# Controls what lands in the sdist. The wheel is driven by
+# [tool.setuptools.packages.find] in pyproject.toml instead.
+#
+# setuptools picks up tests/test_*.py on its own but not conftest.py, which
+# would ship a test suite whose fixtures are all undefined.
+
+include CHANGELOG.md
+include requirements.txt requirements-demo.txt requirements-dev.txt
+recursive-include tests *.py
+recursive-include examples *.py
+
+# data/image.bmp is 480 KB and only feeds one test, which skips when the file
+# is absent. Keep it out of the distribution.
+exclude data/*.bmp

walsh-0.1.1/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: walsh
+Version: 0.1.1
+Summary: Image compression with the Walsh-Hadamard transform
+Author-email: Oskar Jarczyk <oskar.jarczyk@gmail.com>
+Maintainer-email: Oskar Jarczyk <oskar.jarczyk@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/oskar-j/walsh-hadamard-transform
+Project-URL: Repository, https://github.com/oskar-j/walsh-hadamard-transform
+Project-URL: Issues, https://github.com/oskar-j/walsh-hadamard-transform/issues
+Project-URL: Changelog, https://github.com/oskar-j/walsh-hadamard-transform/blob/master/CHANGELOG.md
+Keywords: walsh,hadamard,transform,image,compression,dsp
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<3,>=1.24
+Provides-Extra: demo
+Requires-Dist: matplotlib<4,>=3.7; extra == "demo"
+Requires-Dist: Pillow<13,>=10.0; extra == "demo"
+Dynamic: license-file
+
+# Walsh-hadamard transform
+
+[![PyPI](https://img.shields.io/pypi/v/walsh.svg)](https://pypi.org/project/walsh/)
+[![Python versions](https://img.shields.io/pypi/pyversions/walsh.svg)](https://pypi.org/project/walsh/)
+[![CI](https://github.com/oskar-j/walsh-hadamard-transform/actions/workflows/ci.yml/badge.svg)](https://github.com/oskar-j/walsh-hadamard-transform/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+Compressing images with a Hadamard transform
+
+## Description
+
+**From Wikipedia:** The Hadamard transform (also known as the *Walsh–Hadamard transform*, 
+*Hadamard–Rademacher–Walsh transform*, *Walsh transform*, or *Walsh–Fourier transform*) is an example 
+of a generalized class of Fourier transforms. It performs an orthogonal, symmetric, 
+involutive, linear operation on 2m real numbers (or complex numbers, although the 
+Hadamard matrices themselves are purely real).
+
+The Hadamard transform can be regarded as being built out of *size-2 
+discrete Fourier transforms* (DFTs), and is in fact equivalent to a 
+multidimensional DFT of size `2 × 2 × ⋯ × 2 × 2`. It decomposes an 
+arbitrary input vector into a superposition of *Walsh functions*.
+
+The transform is named for the French mathematician Jacques Hadamard, 
+the German-American mathematician Hans Rademacher, and the 
+American mathematician Joseph L. Walsh. 
+
+The Hadamard transform is also used in data encryption, as well as many signal processing 
+and data compression algorithms, such as `JPEG XR` and `MPEG-4 AVC`. In video compression 
+applications, it is usually used in the form of the sum of absolute transformed differences. 
+It is also a crucial part of *Grover's algorithm* and *Shor's algorithm* in quantum computing. 
+
+## Acknowledgement
+
+This code is partially based on the solution from [ktisha/python2012](https://github.com/ktisha/python2012/tree/dee4beda8e22f3a66a3e31384d4b72ab66102e88/avereshchagin)
+
+## Installation
+
+Requires Python 3.10 or newer.
+
+```
+pip install walsh
+```
+
+or, with [uv](https://docs.astral.sh/uv/):
+
+```
+uv add walsh          # into a project
+uv tool install walsh # just the command line tool
+```
+
+The example script additionally needs matplotlib and Pillow, which are the
+`demo` extra: `pip install "walsh[demo]"`.
+
+### Development
+
+`uv.lock` is committed, so a checkout reproduces exactly the environment CI
+uses:
+
+```
+uv sync --group dev --all-extras
+```
+
+`--group dev` brings in pytest, ruff and mypy; `--all-extras` adds the `demo`
+extra so `examples/roundtrip.py` runs too. Without uv:
+
+```
+pip install -e ".[demo]" -r requirements-dev.txt
+```
+
+## How to run
+
+### Command line
+
+```
+walsh compress data/image.bmp data/transformed.cim
+walsh extract  data/transformed.cim data/recreated.bmp
+```
+
+`compress` accepts `--packed-block-size` (how many low-frequency coefficients
+per axis to keep -- lower is smaller and lossier), `--y-block-size`,
+`--chroma-block-size` and `--coeff-removal`. Add `-v`/`-vv` for progress
+logging, and see `walsh --help` for the full list.
+
+### As a library
+
+```python
+from walsh import Task
+
+Task().with_action("compress").with_input("data/image.bmp").with_output("out.cim").run()
+Task().with_action("extract").with_input("out.cim").with_output("back.bmp").run()
+```
+
+### Example
+
+`examples/roundtrip.py` compresses the sample image, restores it, and plots
+both images with their histograms side by side (needs the `demo` extra):
+
+```
+python examples/roundtrip.py
+```
+
+## Requirements
+
+The package itself needs only `numpy` -- BMP parsing is done by hand with
+`struct`. `matplotlib` and `Pillow` are needed only by the example script, and
+are declared as the `demo` extra. Versions are pinned in `pyproject.toml`;
+`requirements.txt`, `requirements-demo.txt` and `requirements-dev.txt` mirror
+them for plain `pip install -r` workflows.
+
+## Development commands
+
+```
+uv run pytest              # test suite
+uv run ruff check .        # lint
+uv run ruff format .       # format
+uv run mypy                # strict type check
+uv build                   # sdist + wheel into dist/
+```
+
+CI runs exactly these on every pull request, plus the test suite against
+Python 3.10 through 3.14.
+
+## Releasing
+
+The version in `pyproject.toml` is the single source of truth. To cut a
+release, bump it, add the matching `## [x.y.z]` section to `CHANGELOG.md`, and
+merge to `master`. The release workflow then tags `v<version>`, creates a
+GitHub Release with those notes, and publishes the sdist and wheel to
+[PyPI](https://pypi.org/project/walsh/) using Trusted Publishing — no API token
+is stored in this repository.
+
+Merges that do not change the version are a no-op, since PyPI permanently
+refuses to accept the same version twice.
+
+## File format
+
+`compress` writes a `.cim` file: an atypical, project-specific container, so
+most commercial tools will not be able to read it. It stores the image
+dimensions, three block-layout descriptions (Y, Cb, Cr), and the retained
+Walsh-Hadamard coefficients as little-endian `int16`.
+
+## Effects
+
+![https://raw.githubusercontent.com/oskar-j/walsh-hadamard-transform/master/doc/sample_usage.jpg](https://raw.githubusercontent.com/oskar-j/walsh-hadamard-transform/master/doc/sample_usage.jpg)

walsh-0.1.1/README.md

@@ -0,0 +1,144 @@
+# Walsh-hadamard transform
+
+[![PyPI](https://img.shields.io/pypi/v/walsh.svg)](https://pypi.org/project/walsh/)
+[![Python versions](https://img.shields.io/pypi/pyversions/walsh.svg)](https://pypi.org/project/walsh/)
+[![CI](https://github.com/oskar-j/walsh-hadamard-transform/actions/workflows/ci.yml/badge.svg)](https://github.com/oskar-j/walsh-hadamard-transform/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+Compressing images with a Hadamard transform
+
+## Description
+
+**From Wikipedia:** The Hadamard transform (also known as the *Walsh–Hadamard transform*, 
+*Hadamard–Rademacher–Walsh transform*, *Walsh transform*, or *Walsh–Fourier transform*) is an example 
+of a generalized class of Fourier transforms. It performs an orthogonal, symmetric, 
+involutive, linear operation on 2m real numbers (or complex numbers, although the 
+Hadamard matrices themselves are purely real).
+
+The Hadamard transform can be regarded as being built out of *size-2 
+discrete Fourier transforms* (DFTs), and is in fact equivalent to a 
+multidimensional DFT of size `2 × 2 × ⋯ × 2 × 2`. It decomposes an 
+arbitrary input vector into a superposition of *Walsh functions*.
+
+The transform is named for the French mathematician Jacques Hadamard, 
+the German-American mathematician Hans Rademacher, and the 
+American mathematician Joseph L. Walsh. 
+
+The Hadamard transform is also used in data encryption, as well as many signal processing 
+and data compression algorithms, such as `JPEG XR` and `MPEG-4 AVC`. In video compression 
+applications, it is usually used in the form of the sum of absolute transformed differences. 
+It is also a crucial part of *Grover's algorithm* and *Shor's algorithm* in quantum computing. 
+
+## Acknowledgement
+
+This code is partially based on the solution from [ktisha/python2012](https://github.com/ktisha/python2012/tree/dee4beda8e22f3a66a3e31384d4b72ab66102e88/avereshchagin)
+
+## Installation
+
+Requires Python 3.10 or newer.
+
+```
+pip install walsh
+```
+
+or, with [uv](https://docs.astral.sh/uv/):
+
+```
+uv add walsh          # into a project
+uv tool install walsh # just the command line tool
+```
+
+The example script additionally needs matplotlib and Pillow, which are the
+`demo` extra: `pip install "walsh[demo]"`.
+
+### Development
+
+`uv.lock` is committed, so a checkout reproduces exactly the environment CI
+uses:
+
+```
+uv sync --group dev --all-extras
+```
+
+`--group dev` brings in pytest, ruff and mypy; `--all-extras` adds the `demo`
+extra so `examples/roundtrip.py` runs too. Without uv:
+
+```
+pip install -e ".[demo]" -r requirements-dev.txt
+```
+
+## How to run
+
+### Command line
+
+```
+walsh compress data/image.bmp data/transformed.cim
+walsh extract  data/transformed.cim data/recreated.bmp
+```
+
+`compress` accepts `--packed-block-size` (how many low-frequency coefficients
+per axis to keep -- lower is smaller and lossier), `--y-block-size`,
+`--chroma-block-size` and `--coeff-removal`. Add `-v`/`-vv` for progress
+logging, and see `walsh --help` for the full list.
+
+### As a library
+
+```python
+from walsh import Task
+
+Task().with_action("compress").with_input("data/image.bmp").with_output("out.cim").run()
+Task().with_action("extract").with_input("out.cim").with_output("back.bmp").run()
+```
+
+### Example
+
+`examples/roundtrip.py` compresses the sample image, restores it, and plots
+both images with their histograms side by side (needs the `demo` extra):
+
+```
+python examples/roundtrip.py
+```
+
+## Requirements
+
+The package itself needs only `numpy` -- BMP parsing is done by hand with
+`struct`. `matplotlib` and `Pillow` are needed only by the example script, and
+are declared as the `demo` extra. Versions are pinned in `pyproject.toml`;
+`requirements.txt`, `requirements-demo.txt` and `requirements-dev.txt` mirror
+them for plain `pip install -r` workflows.
+
+## Development commands
+
+```
+uv run pytest              # test suite
+uv run ruff check .        # lint
+uv run ruff format .       # format
+uv run mypy                # strict type check
+uv build                   # sdist + wheel into dist/
+```
+
+CI runs exactly these on every pull request, plus the test suite against
+Python 3.10 through 3.14.
+
+## Releasing
+
+The version in `pyproject.toml` is the single source of truth. To cut a
+release, bump it, add the matching `## [x.y.z]` section to `CHANGELOG.md`, and
+merge to `master`. The release workflow then tags `v<version>`, creates a
+GitHub Release with those notes, and publishes the sdist and wheel to
+[PyPI](https://pypi.org/project/walsh/) using Trusted Publishing — no API token
+is stored in this repository.
+
+Merges that do not change the version are a no-op, since PyPI permanently
+refuses to accept the same version twice.
+
+## File format
+
+`compress` writes a `.cim` file: an atypical, project-specific container, so
+most commercial tools will not be able to read it. It stores the image
+dimensions, three block-layout descriptions (Y, Cb, Cr), and the retained
+Walsh-Hadamard coefficients as little-endian `int16`.
+
+## Effects
+
+![https://raw.githubusercontent.com/oskar-j/walsh-hadamard-transform/master/doc/sample_usage.jpg](https://raw.githubusercontent.com/oskar-j/walsh-hadamard-transform/master/doc/sample_usage.jpg)

walsh-0.1.1/examples/roundtrip.py

@@ -0,0 +1,57 @@
+"""Compress an image and restore it, showing both plus their histograms.
+
+Run from the repository root after ``pip install -e .[demo]``::
+
+    python examples/roundtrip.py
+"""
+
+from __future__ import annotations
+
+import logging
+from pathlib import Path
+
+import matplotlib.pyplot as plt
+import numpy as np
+from PIL import Image
+
+from walsh import Task
+
+DATA = Path(__file__).resolve().parent.parent / "data"
+SOURCE = DATA / "image.bmp"
+COMPRESSED = DATA / "transformed.cim"  # raw post-transform data, not a standard format
+RESTORED = DATA / "recreated.bmp"
+
+
+def main() -> None:
+    logging.basicConfig(level=logging.INFO, format="%(levelname)s %(name)s: %(message)s")
+
+    Task().with_action("compress").with_input(str(SOURCE)).with_output(str(COMPRESSED)).run()
+
+    Task().with_action("extract").with_input(str(COMPRESSED)).with_output(str(RESTORED)).run()
+
+    original_bytes = SOURCE.stat().st_size
+    compressed_bytes = COMPRESSED.stat().st_size
+    print(
+        f"{original_bytes:,} B -> {compressed_bytes:,} B "
+        f"({compressed_bytes / original_bytes:.1%} of the original)"
+    )
+
+    # The image after transformation shows a visible loss of quality, and its
+    # colour profile (the per-pixel-value histogram) has shifted as well.
+    before = Image.open(SOURCE)
+    after = Image.open(RESTORED)
+
+    figure, axes = plt.subplots(2, 2, figsize=(14, 10))
+    for column, (title, image) in enumerate((("original", before), ("restored", after))):
+        axes[0][column].imshow(np.asarray(image))
+        axes[0][column].set_title(title)
+        axes[0][column].axis("off")
+        axes[1][column].hist(image.histogram(), bins=40)
+        axes[1][column].set_title(f"{title} histogram")
+
+    figure.tight_layout()
+    plt.show()
+
+
+if __name__ == "__main__":
+    main()

walsh-0.1.1/pyproject.toml

@@ -0,0 +1,78 @@
+[build-system]
+requires = ["setuptools>=77.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "walsh"
+version = "0.1.1"
+description = "Image compression with the Walsh-Hadamard transform"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Oskar Jarczyk", email = "oskar.jarczyk@gmail.com" }]
+maintainers = [{ name = "Oskar Jarczyk", email = "oskar.jarczyk@gmail.com" }]
+keywords = ["walsh", "hadamard", "transform", "image", "compression", "dsp"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Multimedia :: Graphics",
+    "Topic :: Scientific/Engineering :: Image Processing",
+]
+dependencies = ["numpy>=1.24,<3"]
+
+[project.optional-dependencies]
+# A real extra, because `pip install walsh[demo]` is something a user may want:
+# it is what examples/roundtrip.py needs. The package itself parses BMP by hand.
+demo = ["matplotlib>=3.7,<4", "Pillow>=10.0,<13"]
+
+[project.scripts]
+walsh = "walsh.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/oskar-j/walsh-hadamard-transform"
+Repository = "https://github.com/oskar-j/walsh-hadamard-transform"
+Issues = "https://github.com/oskar-j/walsh-hadamard-transform/issues"
+Changelog = "https://github.com/oskar-j/walsh-hadamard-transform/blob/master/CHANGELOG.md"
+
+# PEP 735 groups rather than extras: these are for working on the project, not
+# for installing it. `uv sync --group dev` pulls them in; pip 25.1+ can too,
+# with `pip install --group dev`.
+[dependency-groups]
+dev = [
+    "pytest>=8.0,<10",
+    "ruff>=0.6,<1",
+    "mypy>=1.10,<2",
+    "build>=1.2,<2",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+walsh = ["py.typed"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-ra"
+
+[tool.ruff]
+line-length = 100
+src = ["src", "tests"]
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM", "RUF"]
+
+[tool.mypy]
+# No python_version pin: numpy's bundled stubs require mypy to target 3.12+.
+# Minimum-version compatibility is enforced by ruff's target-version instead.
+packages = ["walsh"]
+strict = true

walsh-0.1.1/requirements-demo.txt

@@ -0,0 +1,7 @@
+# Extra packages needed only by examples/roundtrip.py, which displays the
+# before/after images and their histograms. Equivalent to `pip install .[demo]`.
+
+-r requirements.txt
+
+matplotlib>=3.7,<4
+Pillow>=10.0,<13

walsh-0.1.1/requirements-dev.txt

@@ -0,0 +1,7 @@
+# Test and lint tooling. Equivalent to `pip install -e .[demo,dev]`.
+
+-r requirements-demo.txt
+
+pytest>=8.0,<10
+ruff>=0.6,<1
+mypy>=1.10,<2

walsh-0.1.1/requirements.txt

@@ -0,0 +1,8 @@
+# Runtime dependency of the `walsh` package itself.
+# Authoritative versions live in pyproject.toml; this file mirrors them so the
+# project can also be set up with a plain `pip install -r requirements.txt`.
+#
+# For the example script (examples/roundtrip.py) also install requirements-demo.txt.
+# For tests and linting, install requirements-dev.txt.
+
+numpy>=1.24,<3

walsh-0.1.1/setup.cfg

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

walsh-0.1.1/src/walsh/__init__.py

@@ -0,0 +1,43 @@
+"""Image compression with the Walsh-Hadamard transform.
+
+Typical use::
+
+    from walsh import Task
+
+    Task().with_action("compress").with_input("image.bmp").with_output("out.cim").run()
+    Task().with_action("extract").with_input("out.cim").with_output("back.bmp").run()
+"""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+
+from walsh.colors import ColorModel, RgbColorModel, YCbCrColorModel
+from walsh.image import (
+    BlockDescription,
+    BMPImage,
+    CustomizableImage,
+    UnsupportedFileFormatError,
+)
+from walsh.task import Action, Task
+from walsh.transforms import Transform, WalshHadamardTransform
+
+try:
+    __version__ = version("walsh")
+except PackageNotFoundError:  # pragma: no cover - source checkout without install
+    __version__ = "0.0.0.dev0"
+
+__all__ = [
+    "Action",
+    "BMPImage",
+    "BlockDescription",
+    "ColorModel",
+    "CustomizableImage",
+    "RgbColorModel",
+    "Task",
+    "Transform",
+    "UnsupportedFileFormatError",
+    "WalshHadamardTransform",
+    "YCbCrColorModel",
+    "__version__",
+]