tpircher / pycrc

Free, easy to use Cyclic Redundancy Check (CRC) calculator and source code generator
https://pycrc.org
MIT License
34 stars 8 forks source link

pycrc

pycrc is a free, easy to use Cyclic Redundancy Check (CRC) calculator and C source code generator.

System Requirements

Python 3.7 or newer is required to run pycrc. The last version compatible with Python 2 is v0.9.x.

Running pycrc

This program doesn't need to be installed to be run. The script can be executed from the source directory. Simply call the python interpreter with the script as parameter:

python3 src/pycrc.py [options]

Installation

Install pycrc (if required) using pip:

python3 -m pip install pycrc

or apt (on Debian 13 and later, Ubuntu 23.10 and later, and derivatives):

sudo apt install pycrc

Either of these will install a pycrc binary in the path.

Getting help

If you are new to pycrc and want to generate C code, start with the tutorial.

The pycrc manual page explains the command line options in some detail and also gives some more examples how to use pycrc.

If you have found a bug in pycrc or want to request a feature please take the time and submit it to the issue tracker. Thanks for your help.

Also see the frequently asked questions.

Feedback

If you like pycrc, let me know and drop me a note. If you don't like pycrc let me know what you don't like and why. If you want some idea how to say thanks for this software, please have a look here.

Copyright of the generated source code

The MIT licence allows commercial use of the source and the output of the program. But since I got asked on occasion whether the generated code is encumbered by the copyright of the author, I give my view on this:

The code generated by pycrc is not considered a substantial portion of the software, therefore the licence does not cover the generated code; the author of pycrc will not claim any copyright on the generated code.