Python script to calculate LPC firmware checksums
Project description
# lpc_checksum
Python script to calculate LPC firmware checksums, based on the C version by Roel Verdult. It can be used as a standalone application, or as a Python module that integrates directly in a build environment (e.g. SCons). It does not need to be compiled.
[![Build Status](https://travis-ci.org/basilfx/lpc_checksum.svg?branch=master)](https://travis-ci.org/basilfx/lpc_checksum)
## Requirements
The only requirement is Python 2.7 or Python 3.5+.
## Installation
This module can be installed from Pypi via `pip install lpc_checksum`. Alternatively, you can install the latest version by cloning this repository and run `python setup.py install`.
## Usage
There are two ways of using `lpc_checksum`.
### Standalone
When installed via Pip or from source, the command `lpc_checksum` should be available on your PATH. By default, it assumes the input file is a binary file.
`lpc_checksum <firmware.bin|hex> [--format=bin] [--readonly]`
Program exits with a non-zero error code when it failed.
### As a module
```
import lpc_checksum
checksum = lpc_checksum.checksum(input_file, [readonly=True])
```
On error, an exception will be raised.
## License
See the `LICENSE` file (MIT license).
Python script to calculate LPC firmware checksums, based on the C version by Roel Verdult. It can be used as a standalone application, or as a Python module that integrates directly in a build environment (e.g. SCons). It does not need to be compiled.
[![Build Status](https://travis-ci.org/basilfx/lpc_checksum.svg?branch=master)](https://travis-ci.org/basilfx/lpc_checksum)
## Requirements
The only requirement is Python 2.7 or Python 3.5+.
## Installation
This module can be installed from Pypi via `pip install lpc_checksum`. Alternatively, you can install the latest version by cloning this repository and run `python setup.py install`.
## Usage
There are two ways of using `lpc_checksum`.
### Standalone
When installed via Pip or from source, the command `lpc_checksum` should be available on your PATH. By default, it assumes the input file is a binary file.
`lpc_checksum <firmware.bin|hex> [--format=bin] [--readonly]`
Program exits with a non-zero error code when it failed.
### As a module
```
import lpc_checksum
checksum = lpc_checksum.checksum(input_file, [readonly=True])
```
On error, an exception will be raised.
## License
See the `LICENSE` file (MIT license).
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
lpc_checksum-2.1.1.tar.gz
(22.2 kB
view hashes)
Built Distribution
Close
Hashes for lpc_checksum-2.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8fda5a0ae0f40d568e712d94b13e9bbf724d5bfd962f6258fd5c1d8e32993493 |
|
MD5 | 5878434d15a8d4a5e3ffa41db041a12a |
|
BLAKE2b-256 | b4ec19f57dfebb5ca2f003b05df680c46f4a13984795d4161803817aa52f7770 |