ihexer 0.0.0__tar.gz

ihexer-0.0.0/LICENSE

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) 2025 Avengineers
+
+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.

ihexer-0.0.0/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.3
+Name: ihexer
+Version: 0.0.0
+Summary: Parse, view and diff files in Intel HEX format.
+License: MIT
+Author: Avengineers
+Author-email: karsten.guenther@kamg.de
+Requires-Python: >=3.10,<3.14
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+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: Topic :: Software Development :: Libraries
+Requires-Dist: intelhex (>=2.3,<3.0)
+Requires-Dist: py-app-dev (>=2.1.0,<3.0.0)
+Requires-Dist: typer (>=0.12.3,<0.13.0)
+Project-URL: Bug Tracker, https://github.com/avengineers/ihexer/issues
+Project-URL: Changelog, https://github.com/avengineers/ihexer/blob/develop/CHANGELOG.md
+Project-URL: Documentation, https://ihexer.readthedocs.io
+Project-URL: Repository, https://github.com/avengineers/ihexer
+Description-Content-Type: text/markdown
+
+# Intel HEX Tools
+
+<p align="center">
+  <a href="https://github.com/avengineers/ihexer/actions/workflows/ci.yml?query=branch%3Adevelop">
+    <img src="https://img.shields.io/github/actions/workflow/status/avengineers/ihexer/ci.yml?branch=develop&label=CI&logo=github&style=flat-square" alt="CI Status" >
+  </a>
+  <a href="https://ihexer.readthedocs.io">
+    <img src="https://img.shields.io/readthedocs/ihexer.svg?logo=read-the-docs&logoColor=fff&style=flat-square" alt="Documentation Status">
+  </a>
+  <a href="https://codecov.io/gh/avengineers/ihexer">
+    <img src="https://img.shields.io/codecov/c/github/avengineers/ihexer.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
+  </a>
+</p>
+<p align="center">
+  <a href="https://python-poetry.org/">
+    <img src="https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=" alt="Poetry">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="ruff">
+  </a>
+  <a href="https://github.com/pre-commit/pre-commit">
+    <img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
+  </a>
+</p>
+<p align="center">
+  <a href="https://pypi.org/project/ihexer/">
+    <img src="https://img.shields.io/pypi/v/ihexer.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
+  </a>
+  <img src="https://img.shields.io/pypi/pyversions/ihexer.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
+  <img src="https://img.shields.io/pypi/l/ihexer.svg?style=flat-square" alt="License">
+</p>
+
+Parse, view and diff files in Intel HEX format.
+
+## Installation
+
+Install this via pip (or your favourite package manager):
+
+`pip install ihexer`
+
+## Start developing
+
+The project uses Poetry for dependencies management and packaging.
+Run the `bootstrap.ps1` script to install Python and create the virtual environment. (This is only working on windows machines!)
+
+```powershell
+.\bootstrap.ps1
+```
+
+This will also generate a `poetry.lock` file, you should track this file in version control.
+
+If you want to customize the bootstrapping process please create a bootstrap.json file according to the [bootstrap documentation](https://github.com/avengineers/bootstrap?tab=readme-ov-file#configuration).
+
+To execute the test suite, call pytest inside Poetry's virtual environment via `poetry run`:
+
+```shell
+.venv/Scripts/poetry run pytest
+```
+
+Check out the Poetry documentation for more information on the available commands.
+
+For those using [VS Code](https://code.visualstudio.com/) there are tasks defined for the most common commands:
+
+- bootstrap
+- install dependencies
+- run tests
+- run all checks configured for pre-commit
+- generate documentation
+
+See the `.vscode/tasks.json` for more details.
+
+## Committing changes
+
+This repository uses [commitlint](https://github.com/conventional-changelog/commitlint) for checking if the commit message meets the [conventional commit format](https://www.conventionalcommits.org/en).
+
+## Release
+
+This repository uses [semantic release](https://python-semantic-release.readthedocs.io/en/latest/) to automate versioning the Python projects.
+The package version will be automatically updated when the `develop` branch is built.
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- prettier-ignore-start -->
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- markdownlint-disable -->
+<!-- markdownlint-enable -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+<!-- prettier-ignore-end -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+## Credits
+
+This package was created with
+[Copier](https://copier.readthedocs.io/) and the
+[cuinixam/pypackage-template](https://github.com/cuinixam/pypackage-template)
+project template.
+

ihexer-0.0.0/README.md

@@ -0,0 +1,99 @@
+# Intel HEX Tools
+
+<p align="center">
+  <a href="https://github.com/avengineers/ihexer/actions/workflows/ci.yml?query=branch%3Adevelop">
+    <img src="https://img.shields.io/github/actions/workflow/status/avengineers/ihexer/ci.yml?branch=develop&label=CI&logo=github&style=flat-square" alt="CI Status" >
+  </a>
+  <a href="https://ihexer.readthedocs.io">
+    <img src="https://img.shields.io/readthedocs/ihexer.svg?logo=read-the-docs&logoColor=fff&style=flat-square" alt="Documentation Status">
+  </a>
+  <a href="https://codecov.io/gh/avengineers/ihexer">
+    <img src="https://img.shields.io/codecov/c/github/avengineers/ihexer.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
+  </a>
+</p>
+<p align="center">
+  <a href="https://python-poetry.org/">
+    <img src="https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=" alt="Poetry">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="ruff">
+  </a>
+  <a href="https://github.com/pre-commit/pre-commit">
+    <img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
+  </a>
+</p>
+<p align="center">
+  <a href="https://pypi.org/project/ihexer/">
+    <img src="https://img.shields.io/pypi/v/ihexer.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
+  </a>
+  <img src="https://img.shields.io/pypi/pyversions/ihexer.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
+  <img src="https://img.shields.io/pypi/l/ihexer.svg?style=flat-square" alt="License">
+</p>
+
+Parse, view and diff files in Intel HEX format.
+
+## Installation
+
+Install this via pip (or your favourite package manager):
+
+`pip install ihexer`
+
+## Start developing
+
+The project uses Poetry for dependencies management and packaging.
+Run the `bootstrap.ps1` script to install Python and create the virtual environment. (This is only working on windows machines!)
+
+```powershell
+.\bootstrap.ps1
+```
+
+This will also generate a `poetry.lock` file, you should track this file in version control.
+
+If you want to customize the bootstrapping process please create a bootstrap.json file according to the [bootstrap documentation](https://github.com/avengineers/bootstrap?tab=readme-ov-file#configuration).
+
+To execute the test suite, call pytest inside Poetry's virtual environment via `poetry run`:
+
+```shell
+.venv/Scripts/poetry run pytest
+```
+
+Check out the Poetry documentation for more information on the available commands.
+
+For those using [VS Code](https://code.visualstudio.com/) there are tasks defined for the most common commands:
+
+- bootstrap
+- install dependencies
+- run tests
+- run all checks configured for pre-commit
+- generate documentation
+
+See the `.vscode/tasks.json` for more details.
+
+## Committing changes
+
+This repository uses [commitlint](https://github.com/conventional-changelog/commitlint) for checking if the commit message meets the [conventional commit format](https://www.conventionalcommits.org/en).
+
+## Release
+
+This repository uses [semantic release](https://python-semantic-release.readthedocs.io/en/latest/) to automate versioning the Python projects.
+The package version will be automatically updated when the `develop` branch is built.
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- prettier-ignore-start -->
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- markdownlint-disable -->
+<!-- markdownlint-enable -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+<!-- prettier-ignore-end -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+## Credits
+
+This package was created with
+[Copier](https://copier.readthedocs.io/) and the
+[cuinixam/pypackage-template](https://github.com/cuinixam/pypackage-template)
+project template.

ihexer-0.0.0/pyproject.toml

@@ -0,0 +1,160 @@
+[tool.poetry]
+name = "ihexer"
+version = "0.0.0"
+description = "Parse, view and diff files in Intel HEX format."
+authors = ["Avengineers <karsten.guenther@kamg.de>"]
+license = "MIT"
+readme = "README.md"
+repository = "https://github.com/avengineers/ihexer"
+documentation = "https://ihexer.readthedocs.io"
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries",
+]
+packages = [
+    { include = "ihexer", from = "src" },
+]
+
+[tool.poetry.urls]
+"Bug Tracker" = "https://github.com/avengineers/ihexer/issues"
+"Changelog" = "https://github.com/avengineers/ihexer/blob/develop/CHANGELOG.md"
+
+[tool.poetry.dependencies]
+python = ">=3.10,<3.14"
+py-app-dev = "^2.1.0"
+typer = "^0.12.3"
+intelhex = "^2.3"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.0"
+pytest-cov = "^4.0"
+pre-commit = "^3.1.1"
+ruff = "^0.3.0"
+pypeline-runner = "^0.3"
+python-semantic-release = "^9.1"
+
+[tool.poetry.group.docs.dependencies]
+myst-parser = ">=0.16"
+sphinx = "^7.3.5"
+sphinxcontrib-mermaid = "^0.9.2"
+mlx-traceability = "^10.0.0"
+sphinx-copybutton = "^0.5.2"
+sphinx-new-tab-link = "^0.4.0"
+sphinx-book-theme = "^1.1.2"
+sphinx-design = "^0.5.0"
+
+[tool.semantic_release]
+version_toml = ["pyproject.toml:tool.poetry.version"]
+version_variables = [
+    "src/ihexer/__init__.py:__version__",
+    "docs/conf.py:release",
+]
+build_command = "pip install poetry && poetry build"
+
+[tool.semantic_release.changelog]
+exclude_commit_patterns = [
+    "chore*",
+    "ci*",
+]
+
+[tool.semantic_release.changelog.environment]
+keep_trailing_newline = true
+
+[tool.semantic_release.branches.main]
+match = "develop"
+
+[tool.semantic_release.branches.noop]
+match = "(?!develop$)"
+prerelease = true
+
+[tool.pytest.ini_options]
+addopts = "-v -Wdefault --cov=ihexer --cov-report=term-missing:skip-covered"
+pythonpath = ["src"]
+
+[tool.coverage.run]
+branch = true
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "@overload",
+    "if TYPE_CHECKING",
+    "raise NotImplementedError",
+    'if __name__ == "__main__":',
+]
+
+[tool.ruff]
+target-version = "py38"
+line-length = 180
+lint.ignore = [
+    "D203", # 1 blank line required before class docstring
+    "D212", # Multi-line docstring summary should start at the first line
+    "D100", # Missing docstring in public module
+    "D101", # Missing docstring in public class
+    "D102", # Missing docstring in public method
+    "D103", # Missing docstring in public function
+    "D104", # Missing docstring in public package
+    "D107", # Missing docstring in `__init__`
+    "D401", # First line of docstring should be in imperative mood
+]
+lint.select = [
+    "B",   # flake8-bugbear
+    "D",   # flake8-docstrings
+    "C4",  # flake8-comprehensions
+    "S",   # flake8-bandit
+    "F",   # pyflake
+    "E",   # pycodestyle
+    "W",   # pycodestyle
+    "UP",  # pyupgrade
+    "I",   # isort
+    "RUF", # ruff specific
+]
+exclude = [
+    "bootstrap.py"
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*" = [
+    "D100",
+    "D101",
+    "D102",
+    "D103",
+    "D104",
+    "S101",
+]
+"setup.py" = ["D100"]
+"conftest.py" = ["D100"]
+"docs/conf.py" = ["D100"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["ihexer", "tests"]
+
+[tool.mypy]
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+mypy_path = "src/"
+no_implicit_optional = true
+show_error_codes = true
+warn_unreachable = true
+warn_unused_ignores = true
+exclude = [
+    'docs/.*',
+    'setup.py',
+]
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+allow_untyped_defs = true
+
+[[tool.mypy.overrides]]
+module = "docs.*"
+ignore_errors = true
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

ihexer-0.0.0/src/ihexer/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.0"

ihexer-0.0.0/src/ihexer/_run.py

@@ -0,0 +1,12 @@
+"""
+Used to run ihexer from the command line when run from this repository.
+
+This is required because ihexer module is not visible when running from the repository.
+"""
+
+import runpy
+import sys
+from pathlib import Path
+
+sys.path.insert(0, Path(__file__).parent.parent.absolute().as_posix())
+runpy.run_module("ihexer.main", run_name="__main__")

ihexer-0.0.0/src/ihexer/ihexer.py

@@ -0,0 +1,193 @@
+import difflib
+from dataclasses import dataclass
+from pathlib import Path
+from typing import List
+
+from intelhex import IntelHex as _IntelHex
+from py_app_dev.core.exceptions import UserNotificationException
+
+
+@dataclass
+class IntelHexSegment:
+    start: int
+    end: int
+    data: bytes
+
+    @property
+    def length(self) -> int:
+        return self.end - self.start + 1
+
+    def __post_init__(self) -> None:
+        """Make sure the segment can have a size."""
+        if self.end < self.start:
+            raise ValueError(f"Segments length has negative size: end {self.end} < start {self.start}.")
+
+    def __str__(self) -> str:
+        """Only print the address range."""
+        return f"{hex(self.start)}-{hex(self.end)}: {self.length} bytes"
+
+
+@dataclass
+class IntelHex:
+    start_address: int
+    end_address: int
+    segments: List[IntelHexSegment]
+
+    def get_content(self) -> str:
+        """Return the hex content of all segments as a single long string."""
+        hex_content = []
+        for segment in self.segments:
+            hex_content.append(segment.data.hex().upper())
+        return "".join(hex_content)
+
+    def __str__(self) -> str:
+        """Return the content when the object is printed."""
+        return self.get_content()
+
+    def write_hex_file(self, output_file: Path) -> None:
+        """Write the IntelHex content back to a hex file."""
+        # Create a new _IntelHex object to store the data
+        intel_hex = _IntelHex()
+
+        # For each segment, add its data to the _IntelHex object
+        for segment in self.segments:
+            intel_hex.puts(segment.start, segment.data)
+
+        # Write the data to the specified file
+        intel_hex.write_hex_file(output_file.as_posix())
+
+
+class IntelHexParser:
+    def __init__(self, file: Path, bytes_swap: bool = False, word_size: int = 4) -> None:
+        self.file = file
+        self.bytes_swap = bytes_swap
+        self.word_size = word_size
+
+    def parse(self) -> IntelHex:
+        segments = self._read_segments(self._parse_content())
+        return IntelHex(
+            min([segment.start for segment in segments]),
+            max([segment.end for segment in segments]),
+            segments,
+        )
+
+    def _parse_content(self) -> _IntelHex:
+        _content = _IntelHex()
+        format = self.file.suffix.lower().replace(".", "")
+        try:
+            _content.loadfile(self.file.as_posix(), format)
+        except ValueError as e:
+            raise UserNotificationException(f"Could not load '{self.file}'. Unsupported format {format}") from e
+        return _content
+
+    def _read_segments(self, content: _IntelHex) -> List[IntelHexSegment]:
+        segments: List[IntelHexSegment] = []
+        _segments = content.segments()
+        if _segments:
+            for segment_addresses_list in _segments:
+                start_address = segment_addresses_list[0]
+                # For some reason IntelHex sets the end address to the next available address. Bug?
+                end_address = segment_addresses_list[1] - 1
+                data: bytes = content.gets(start_address, end_address - start_address + 1)
+                if self.bytes_swap:
+                    data = self.swap_bytes(data, self.word_size)
+                segments.append(
+                    IntelHexSegment(
+                        start_address,
+                        end_address,
+                        data,
+                    )
+                )
+        return segments
+
+    @staticmethod
+    def swap_bytes(data: bytes, word_size: int) -> bytes:
+        if len(data) % word_size != 0:
+            raise UserNotificationException(f"Data length {len(data)} is not a multiple of word size {word_size}.")
+        swapped_data = bytearray()
+        for i in range(0, len(data), word_size):
+            swapped_data.extend(reversed(data[i : i + word_size]))
+        return bytes(swapped_data)
+
+
+class IntelHexPrinter:
+    def __init__(self, content: IntelHex) -> None:
+        self.content = content
+
+    @staticmethod
+    def stringify_segment(segment: IntelHexSegment) -> List[str]:
+        output_lines = []
+        # Calculate the alignment offset from the nearest lower multiple of 16
+        alignment_offset = segment.start % 16
+
+        # Adjust the start address to be aligned to 16 bytes
+        aligned_start_address = segment.start - alignment_offset
+
+        # Calculate the number of lines, ensuring at least one line
+        # Include the offset in the calculation for total data length
+        num_lines = (len(segment.data) + alignment_offset + 15) // 16 if segment.data else 1
+
+        for i in range(num_lines):
+            start_idx = i * 16 - alignment_offset
+            end_idx = start_idx + 16
+            current_data_chunk = segment.data[max(0, start_idx) : end_idx]
+
+            address_str = f"{aligned_start_address + i*16:08X}"
+
+            # Prepare the data bytes, filling missing bytes with '--' at the beginning due to alignment
+            data_strs = ["--"] * max(0, -start_idx)  # Fill with '--' if start_idx is negative
+            data_strs += [f"{byte:02X}" for byte in current_data_chunk]
+            missing_bytes = 16 - len(data_strs)
+            data_strs.extend(["--"] * missing_bytes)
+
+            data_str = " ".join(data_strs)
+            segment_str = f"{address_str}: {data_str}"
+            output_lines.append(segment_str)
+        return output_lines
+
+    @staticmethod
+    def stringify_segments(segments: List[IntelHexSegment]) -> List[str]:
+        output_lines = []
+        for segment in segments:
+            output_lines.extend(IntelHexPrinter.stringify_segment(segment))
+        return output_lines
+
+    @staticmethod
+    def stringify_short_info(segments: List[IntelHexSegment]) -> List[str]:
+        delimiter = "-" * 57
+        output_lines = [delimiter, "SEGMENTS:"]
+        for segment in segments:
+            output_lines.append(str(segment))
+        output_lines.append(delimiter)
+        return output_lines
+
+    def to_string(self, with_short_info: bool = True) -> str:
+        content = []
+        if with_short_info:
+            content.extend(IntelHexPrinter.stringify_short_info(self.content.segments))
+        content.extend(IntelHexPrinter.stringify_segments(self.content.segments))
+        return "\n".join(content)
+
+
+class IntelHexDiff:
+    def __init__(self, first: Path, second: Path) -> None:
+        self.first_file = first
+        self.second_file = second
+
+    def generate_html(self) -> str:
+        first_list = IntelHexPrinter.stringify_segments(IntelHexParser(self.first_file).parse().segments)
+        second_list = IntelHexPrinter.stringify_segments(IntelHexParser(self.second_file).parse().segments)
+
+        html_diff = difflib.HtmlDiff()
+
+        return html_diff.make_file(
+            first_list,
+            second_list,
+            fromdesc=f"{self.first_file}",
+            todesc=f"{self.second_file}",
+            context=True,
+            numlines=5,
+        )
+
+    def generate(self, out_file: Path) -> None:
+        out_file.write_text(self.generate_html())

ihexer-0.0.0/src/ihexer/main.py

@@ -0,0 +1,80 @@
+import sys
+from pathlib import Path
+from typing import Optional
+
+import typer
+from py_app_dev.core.exceptions import UserNotificationException
+from py_app_dev.core.logging import logger, setup_logger, time_it
+
+from ihexer import __version__
+from ihexer.ihexer import IntelHexDiff, IntelHexParser, IntelHexPrinter
+
+package_name = "ihexer"
+
+app = typer.Typer(name=package_name, help="Intel HEX utils.", no_args_is_help=True)
+
+
+@app.callback(invoke_without_command=True)
+def version(
+    version: bool = typer.Option(None, "--version", "-v", is_eager=True, help="Show version and exit."),
+) -> None:
+    if version:
+        typer.echo(f"{package_name} {__version__}")
+        raise typer.Exit()
+
+
+@app.command()
+@time_it("view")
+def view(
+    file: Path = typer.Option(help="Input hex/bin file."),  # noqa: B008
+    dump_to: Optional[Path] = typer.Option(None, help="Output file to dump the hex content."),  # noqa: B008
+    short_info: bool = typer.Option(True, help="Dump hex file short info before the content."),
+) -> None:
+    intel_hex = IntelHexParser(file).parse()
+    print(IntelHexPrinter(intel_hex).to_string(short_info))
+    if dump_to:
+        dump_to.write_text(IntelHexPrinter(intel_hex).to_string(short_info))
+
+
+@app.command()
+@time_it("diff")
+def diff(
+    first: Path = typer.Option(help="First input hex/bin file."),  # noqa: B008
+    second: Path = typer.Option(help="Second input hex/bin file."),  # noqa: B008
+    out_file: Path = typer.Option(help="Output file to write the html diff report."),  # noqa: B008
+) -> None:
+    IntelHexDiff(first, second).generate(out_file)
+
+
+@app.command()
+@time_it("info")
+def info(
+    file: Path = typer.Option(help="Input hex/bin file."),  # noqa: B008
+) -> None:
+    intel_hex = IntelHexParser(file).parse()
+    for line in IntelHexPrinter.stringify_short_info(intel_hex.segments):
+        print(line)
+
+
+@app.command()
+@time_it("swap")
+def swap(
+    file: Path = typer.Option(help="Input hex/bin file."),  # noqa: B008
+    out_file: Optional[Path] = typer.Option(None, help="Output file to write the swapped hex content."),  # noqa: B008
+    word_size: int = typer.Option(4, help="Word size in bytes."),
+) -> None:
+    IntelHexParser(file, bytes_swap=True, word_size=word_size).parse().write_hex_file(out_file or file)
+
+
+def main() -> int:
+    try:
+        setup_logger()
+        app()
+        return 0
+    except UserNotificationException as e:
+        logger.error(f"{e}")
+        return 1
+
+
+if __name__ == "__main__":
+    sys.exit(main())