Intel HEX Tools

Intel HEX Tools#

CI Status Documentation Status Test coverage percentage

Poetry ruff pre-commit

PyPI Version Supported Python versions License

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 build.ps1 script to install Python and create the virtual environment. (This is only working on windows machines!)

.\build.ps1 -install

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.

To execute the test suite, call pytest inside Poetry’s virtual environment via poetry run:

.venv/Scripts/poetry run pytest

Check out the Poetry documentation for more information on the available commands.

For those using VS Code 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 for checking if the commit message meets the conventional commit format.

Release#

This repository uses semantic release 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):

This project follows the all-contributors specification. Contributions of any kind welcome!

Credits#

This package was created with Copier and the cuinixam/pypackage-template project template.

Contents