Metadata-Version: 2.4
Name: speedrunpapi
Version: 0.5.0
Summary: ᑕ. exact arithmetic circuit verification; Python entry to the shared Node engine
Author: Colony Technology
Project-URL: Homepage, https://colony.technology
Project-URL: Source, https://github.com/lmtlssss/speedrunpapi
Keywords: circom,r1cs,bitvm,zkvm,verilog,state contraction
Classifier: Programming Language :: Python :: 3
Classifier: Environment :: Console
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.md
Dynamic: license-file

# speedrunpapi for Python

The Python package supplies the same bundled ᑕ. analyzer as the npm and browser distributions. It requires Node.js 20 or later on `PATH` and works offline for local scans.

Install the [v0.5.0 wheel](https://github.com/lmtlssss/speedrunpapi/releases/tag/v0.5.0) with `pip install https://github.com/lmtlssss/speedrunpapi/releases/download/v0.5.0/speedrunpapi-0.5.0-py3-none-any.whl`, then run `speedrunpapi scan circuit.circom --json` or `speedrunpapi version`. PyPI uses the repository's trusted publisher. The package invokes its bundled JavaScript engine; it does not download executable code at run time.

Local scans are free. A paid signed certificate requires a Colony API key. Native Bitcoin Script assembly/bytecode supports alternate-stack transfer and hash opcodes; RV32IM v2 records branches, jumps, aligned word loads and stores. BN254 R1CS v1 checks coupled full-rank linear constraints and exact square-zero elimination. Use `speedrunpapi verify result.json --source input.file` for an independent source recheck. Unsupported code and rank-deficient systems return `Unknown`.
