crcglot

PyPI license Py 3.11 Py 3.12 Py 3.13 Py 3.14 coverage ruff ty

The CRC backend an AI assistant can delegate to. Deterministic, reveng-anchored CRC answers: compute, detect, reverse-engineer, and verify CRCs from a catalogue of 100+ algorithms, plus execution-verified code generation for C / C++ ⚙️, Rust 🦀, Go 🚦, C# #️⃣, Java ☕, Lua 🌙, Python 🐍, TypeScript 🔷, Zig ⚡, Verilog 🔧, and VHDL 🔌. Call it over MCP, from the CLI, or in Python. Zero-dependency core: stdlib only (an optional bundled C accelerator speeds up computation; the optional MCP server adds the MCP SDK).

Reach for it when a CRC crosses a boundary you don't control: a device to talk to, a capture to identify, an unknown checksum to reverse-engineer, or a verified implementation to drop into firmware. CRC code is easy to write and hard to trust, and the verification is what this package is really selling: answers come from the published reveng catalogue, everything it generates was compiled and executed against independent reference vectors before release, and every file embeds a self-test so you can re-run the check on your own toolchain. For bulk runtime hashing throughput, when to reach for something else names the better tool.

Quick start

A packet in one hand, a mystery CRC in the other: name it, then generate the verified implementation:

uv tool install crcglot

$ crcglot detect --hex "313233343536373839cbf43926"
crc32  width=32  endianness=big  form=hex  separator=''  prefix=''  per_byte=False  uppercase=False

$ crcglot c crc32 file=mycrc
Note: Faster CRC-32 path on C / C++: zlib's `crc32()` (`<zlib.h>`).  The generated code is fine for small messages, but for large files or streaming throughput prefer that library; it uses CPU CRC instructions where the processor supports them.
Wrote <your dir>\mycrc.h
Wrote <your dir>\mycrc.c

That's mycrc.h + mycrc.c: a verified CRC-32 with a built-in _self_test() that re-checks it against four independent reference CRCs on your toolchain.

The whole model is three choices: which algorithm (crc32, crc16-modbus, … ; crcglot list shows the more than 100), which language (c / python / rust / vhdl / verilog / go / csharp / java / typescript / zig / lua), and whether you want it --fast (fastest the target supports, and the default) or --small (smallest code). crcglot figures out the implementation details, so you never have to know what "slice-by-8" is.

crcglot rust crc32 file=mycrc            # fastest Rust crc32 (the default) to mycrc.rs
crcglot c crc8 --small                   # smallest C crc8, to stdout

Installation

uv tool install crcglot      # the CLI on PATH
uv add crcglot               # as a library in your project

Python 3.11+, zero runtime dependencies: crcglot imports nothing beyond the standard library. (The prebuilt wheels bundle an optional C accelerator for runtime CRC computation, covered in docs/api.md, so the package is not "pure Python" in the packaging sense, but it runs fully, on any platform, without it.) Per-target toolchains (gcc, rustc, tsx, iverilog, etc.) only matter if you want to run the generated code; the generator produces source either way.

What you get per language

Function Purpose
<fname>_init / _update / _finalize Streaming triple; feed data chunk by chunk
<fname> One-shot wrapper that calls the streaming triple
<fname>_self_test Verify against embedded reference CRCs on your toolchain (what each target checks: docs/generated-code.md)

Every target ships a runtime-callable _self_test(): C returns 0/1; Rust / Go / C# / Java / Lua / TypeScript / Zig / Python / Verilog / VHDL return bool / boolean / bit. No #[cfg(test)] gating, so you can call it from your release build, a boot self-check, or a startup assertion. Zig additionally emits a native test declaration, so zig test <file>.zig verifies the module with no harness. The generated files are also documented (per-language doc-tool styles) and named in each target's idiomatic casing; see docs/generated-code.md.

The generated Python is pure Python: portable and dependency-free, but interpreted, so it is the slow path. Generate the .py to port a CRC into a zero-dependency codebase; to compute fast in Python, call crcglot's own runtime instead (below).

How it's verified

The guarantee is behavioral, not structural. crcglot doesn't lint the generated code, it runs it: every one of the more than 100 algorithms, in every variant a target supports, in every one of the eleven languages, is generated, run through its real toolchain (gcc, rustc, go, dotnet, javac, tsx, zig, lua, iverilog, ghdl), and executed against reference vectors computed by two engines that are not ours. Ten categories of evidence make up the verification matrix, from reference vectors through adversarial review, and all of it is yours to re-run. docs/verification/index.md explains the review model and maps every category to the tests that carry it.

Every generated file also embeds a _self_test() over independent reference vectors. Call it once in your build environment (a unit test, a startup assertion, a boot check): CI compiles and runs the generated code through every target toolchain on Linux for each change, releases are re-verified across the full toolchain set on a Windows reference box, and only running the self-test on yours confirms your compiler, flags, endianness, and integer widths agree. What it checks, where its expected values come from, and what it buys you beyond correctness (a boot-time integrity check, auditability, a cleaner story for regulated builds) are in docs/generated-code.md.

Use it with Claude (and any MCP client)

crcglot[mcp] exposes the toolkit as a Model Context Protocol server, so an assistant (Claude Desktop, Claude Code, Cursor, mcp-cli, …) does the judgment (which tool, which parameters, what the result means) while crcglot does the arithmetic. The hardest case, recovering an unknown custom CRC from captured frames, is worked end to end as a real chat session in docs/MCP.md.

uv tool install 'crcglot[mcp]'    # the extra ships the MCP SDK

Then wire it in. Claude Code, one command:

claude mcp add crcglot -- uvx --from 'crcglot[mcp]' crcglot-mcp

Claude Desktop (and other clients), via claude_desktop_config.json:

{
  "mcpServers": {
    "crcglot": {
      "command": "uvx",
      "args": ["--from", "crcglot[mcp]", "crcglot-mcp"]
    }
  }
}

Tools: crc_list · crc_info · crc_self_test_vectors · crc_detect · crc_reverse · crc_identify_trailer · crc_verify · crc_encode · crc_compute · crc_compute_many · crc_generate · crc_credits. Resources: crcglot://catalogue.json · crcglot://languages.json · crcglot://variants.json · crcglot://verbs.json. Full reference and setup walkthrough live in docs/MCP.md.

CLI at a glance

Subcommand What it does
crcglot list [GLOB] Browse the catalogue (more than 100 algorithms)
crcglot info <name> Full Rocksoft/Williams parameters for one algorithm
crcglot detect Name the catalogue CRC ending a packet (file, hex, text, or a crclink JSON frame)
crcglot identify Name a non-CRC trailer: checksum (sum/LRC/XOR/Fletcher/Adler) or digest (MD5/SHA/BLAKE2, full or truncated); notes a likely MAC when nothing matches
crcglot reverse Recover the parameters of an unknown / custom CRC; prints ready-to-paste --custom tokens
crcglot verify Check a frame's trailing CRC against a named algorithm
crcglot encode Build a packet by appending the CRC (round-trip partner to detect)
crcglot compute The raw CRC integer of some data
crcglot c | rust | go | … Generate verified source for that language (--fast default, --small, --custom, bundling, --comment, --naming)
crcglot credits Acknowledgments for the work crcglot builds on
crcglot version Installed crcglot version (the same string stamped into generated code)

Every option, token, and example lives in docs/cli.md.

Catalogue

More than 100 algorithms covering everything from CRC-8 (ATM, AUTOSAR, Bluetooth, Maxim 1-Wire) through CRC-16 (Modbus, XMODEM, CCITT, IBM SDLC) through CRC-32 (Ethernet, bzip2, iSCSI, AUTOSAR) to CRC-64 (XZ, ECMA-182, NVMe, Redis), plus the non-byte-aligned families: CAN (CRC-15), CAN FD (CRC-17/21), FlexRay (CRC-11/24), LTE/BLE/OpenPGP (CRC-24), and the GSM/UMTS/CDMA2000 telecom set. Browse with crcglot list.

Programmatic API

Everything the CLI does is callable from Python, behind two typed registries. import crcglot loads only the compute core (4 modules, ~30 ms); the rest loads on first use.

from crcglot import LANGUAGES, ALGORITHMS

header, source = LANGUAGES["c"].generator("crc32")     # generate
modbus = ALGORITHMS["crc16-modbus"]                    # introspect
print(modbus.width, hex(modbus.check), modbus.desc)
# → 16 0x4b37 Modbus RTU serial protocol

LanguageInfo carries everything a UI or build script needs per target (extensions, variants, generators, naming/casing helpers); AlgorithmInfo is the full parameter set; VERBS is the verb manifest, every verb's parameters and choices as plain data for frontends that render typed tools, with call_verb(name, **params) as their uniform invoker. Custom polynomials plug into the same generators via generator_from_entry. The full API is in docs/api.md.

Pointing an LLM or coding agent at crcglot? Start with llms.txt: a concise, linked map of what the package does and where to look, to load first instead of crawling the source.

Fast runtime CRC (optional C extension)

Beyond generating code, crcglot computes CRCs at runtime. With the bundled C extension, any of the more than 100 CRCs runs from Python at compiled-C-class throughput on bulk data (~1.7 GB/s on a 1 MiB buffer), and IEEE CRC-32 / JAMCRC ride the stdlib's hardware path (tens of GB/s); the pure-Python fallback always works, far more slowly. generic_crc(data, crc) picks the fastest path available, with no variant knob. Streaming (crc_stream) and batch (generic_crc_many) APIs, the hot-loop warning, and the dispatch details are in docs/api.md; measured figures are in BENCHMARKS.md.

Example output and benchmarks

  • EXAMPLES.md: the actual generated source, in three tours: every language, every implementation variant, every documentation style. Each block is reproducible with the one CLI command shown above it.
  • BENCHMARKS.md: measured throughput for every (language × variant) cell, plus the runtime engine's paths.

When to reach for something else

crcglot tries to be the whole toolbox for CRC problems, not the best tool for every CRC-adjacent job. Two pointers:

  • Bulk runtime hashing of non-CRC-32 algorithms: anycrc computes any ≤64-bit CRC via hardware carry-less multiplication at ~10× crcglot's C-extension throughput on large in-memory buffers. If your workload is "checksum gigabytes that are already in RAM with crc16," use it. (For IEEE CRC-32 crcglot already rides the stdlib's hardware path, and for small framed messages its batch API is the faster of the two. Behind real file I/O the difference mostly disappears; see BENCHMARKS.md.) crcglot uses anycrc itself, as one of the two independent engines that generate its reference vectors.
  • Deep reverse-engineering of pathological captures: reveng (the C tool) has decades of accumulated handling for obscure reversal cases. crcglot's reverse() / crc_reverse covers the common paths (catalogue identification plus algebraic recovery of custom parameters), but if it comes up empty on a gnarly capture, reveng is the reference instrument, and its catalogue is the source crcglot's own algorithm data derives from.

Acknowledgments

crcglot builds on:

  • The reveng CRC catalogue by Greg Cook: the canonical source of CRC algorithm parameters since 1999, and the source of the more than 100 parameter sets, descriptions, and check values every catalogue entry in crcglot is derived from.
  • zlib by Mark Adler, Jean-loup Gailly et al.: the runtime fast path for CRC-32/ISO-HDLC and JAMCRC, which take the PCLMULQDQ folding path on x86 and the PMULL / crc32 instructions on ARM.
  • The Rocksoft Model CRC parameterization by Ross N. Williams: the (width, poly, init, refin, refout, xorout, check) vocabulary every catalogue entry is expressed in.

crcglot credits prints this same content in the terminal, and crcglot.ATTRIBUTION / crcglot.ACKNOWLEDGMENTS expose it programmatically.

License

MIT

Project links

Data verified by PyPI on Aug 15, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for hucker233 from gravatar.com hucker233

Credits

PyPI data
Data sourced directly from PyPI's database.

Author: Chuck Bass

GitHub Statistics

Data verified by PyPI on Aug 15, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.11

Provides Extra

mcp

Tags

crc checksum reveng rocksoft williams detect reverse-engineering verify mcp code-generation embedded

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

crcglot-0.31.0.tar.gz (416.3 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

crcglot-0.31.0-cp311-abi3-win_arm64.whl (267.0 kB view details)

Uploaded CPython 3.11+Windows ARM64

crcglot-0.31.0-cp311-abi3-win_amd64.whl (267.9 kB view details)

Uploaded CPython 3.11+Windows x86-64

crcglot-0.31.0-cp311-abi3-musllinux_1_2_x86_64.whl (283.3 kB view details)

Uploaded CPython 3.11+musllinux: musl 1.2+ x86-64

crcglot-0.31.0-cp311-abi3-musllinux_1_2_aarch64.whl (283.1 kB view details)

Uploaded CPython 3.11+musllinux: musl 1.2+ ARM64

crcglot-0.31.0-cp311-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (282.8 kB view details)

Uploaded CPython 3.11+manylinux: glibc 2.17+ ARM64

crcglot-0.31.0-cp311-abi3-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (283.2 kB view details)

Uploaded CPython 3.11+manylinux: glibc 2.17+ x86-64manylinux: glibc 2.5+ x86-64

crcglot-0.31.0-cp311-abi3-macosx_11_0_arm64.whl (264.5 kB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

File details

Details for the file crcglot-0.31.0.tar.gz.

File metadata

  • Download URL: crcglot-0.31.0.tar.gz
  • Upload date:
  • Size: 416.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for crcglot-0.31.0.tar.gz
Algorithm Hash digest
SHA256 68289fa744c75ad82b565100b8cb75ae8920b9c1defd2a9448a86ce17d65d668
MD5 563385c85cc952c31b52d7b6e0de83d9
BLAKE2b-256 98c303d0d69e1e87c3c32c2b3780dbae14aeb252855c7ce6a332f0c19bb71eb4

See more details on using hashes here.

Provenance

The following attestation bundles were made for crcglot-0.31.0.tar.gz:

Publisher: wheels.yml on hucker/crcglot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file crcglot-0.31.0-cp311-abi3-win_arm64.whl.

File metadata

  • Download URL: crcglot-0.31.0-cp311-abi3-win_arm64.whl
  • Upload date:
  • Size: 267.0 kB
  • Tags: CPython 3.11+, Windows ARM64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for crcglot-0.31.0-cp311-abi3-win_arm64.whl
Algorithm Hash digest
SHA256 d6f4a5784564d63a160030a60b8dc77081dfdc8c86fbab8dd721bb3bd574e278
MD5 255164168e4c214061d530668e0a29d2
BLAKE2b-256 f6c932d4421009395d78d1308f9aaa17b6e2d02dcfb4e2086cae7c502cea1fac

See more details on using hashes here.

Provenance

The following attestation bundles were made for crcglot-0.31.0-cp311-abi3-win_arm64.whl:

Publisher: wheels.yml on hucker/crcglot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file crcglot-0.31.0-cp311-abi3-win_amd64.whl.

File metadata

  • Download URL: crcglot-0.31.0-cp311-abi3-win_amd64.whl
  • Upload date:
  • Size: 267.9 kB
  • Tags: CPython 3.11+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for crcglot-0.31.0-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 46cfb263a9e11198d4b842e0dce35c2dc38f04a028004e94449ec6507fa25089
MD5 868403db2e71f5a2b0527ee11a70092a
BLAKE2b-256 e2c8b70f44692b8c66f258de9ffc610fd2c19d30126c1a44b685249a64141ba1

See more details on using hashes here.

Provenance

The following attestation bundles were made for crcglot-0.31.0-cp311-abi3-win_amd64.whl:

Publisher: wheels.yml on hucker/crcglot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file crcglot-0.31.0-cp311-abi3-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for crcglot-0.31.0-cp311-abi3-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 c539c77851253e5e61f4a8faed923b8de9149b7cde3ac14b55e7d1e0ba864270
MD5 0b0bff1d93b0a06b3aa841f5e0fbd19d
BLAKE2b-256 5f8bae2514325e387c15c039aaf8b86c3e13a34298ea4575589c418cf16c7f46

See more details on using hashes here.

Provenance

The following attestation bundles were made for crcglot-0.31.0-cp311-abi3-musllinux_1_2_x86_64.whl:

Publisher: wheels.yml on hucker/crcglot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file crcglot-0.31.0-cp311-abi3-musllinux_1_2_aarch64.whl.

File metadata

File hashes

Hashes for crcglot-0.31.0-cp311-abi3-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 93bdf01863b81269717ed735d12e15a503619ca2f4dd1794be0f14ce36c53790
MD5 20b027944888f1bbdd895fe34cda6b98
BLAKE2b-256 0a25fbad03210cee30198d8bd046de1f44a08cbf0f76f9e4df80c3b41d824cba

See more details on using hashes here.

Provenance

The following attestation bundles were made for crcglot-0.31.0-cp311-abi3-musllinux_1_2_aarch64.whl:

Publisher: wheels.yml on hucker/crcglot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file crcglot-0.31.0-cp311-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for crcglot-0.31.0-cp311-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 d31b54b68927d89764b4f8f4c0f1ae908fed90d6b7afc64d4c804fe8da7b8c72
MD5 ca59e70c4fab6a738a2aa18b1ba13281
BLAKE2b-256 0daf350bbbeaabee8d3e15cf0958efd31993e3e5a67de220d2cb3ed13e55decc

See more details on using hashes here.

Provenance

The following attestation bundles were made for crcglot-0.31.0-cp311-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl:

Publisher: wheels.yml on hucker/crcglot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file crcglot-0.31.0-cp311-abi3-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for crcglot-0.31.0-cp311-abi3-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 81a5c9e6ae987260f609750d11c8a60174a12d0886758f9028eb3060f21faceb
MD5 1b334bc78ded73cfb58de821f2fd8586
BLAKE2b-256 a41ed7366200bdc772c7552701349a961ae3560abcb4620146829a29b6ca0ad4

See more details on using hashes here.

Provenance

The following attestation bundles were made for crcglot-0.31.0-cp311-abi3-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: wheels.yml on hucker/crcglot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file crcglot-0.31.0-cp311-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for crcglot-0.31.0-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 3bcc7cd1b68074d80bf3bf4e1416496e2d87792697becdfa70e8234a4fd9cf7c
MD5 78afe2fea656db0c53ae945056a24250
BLAKE2b-256 02188e8e585c9995036e8362e85b49b70cdb3187c36a7589a8924664d8251614

See more details on using hashes here.

Provenance

The following attestation bundles were made for crcglot-0.31.0-cp311-abi3-macosx_11_0_arm64.whl:

Publisher: wheels.yml on hucker/crcglot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page