CANConfigPython

Python CLI and API for CANHub, CANFB, CANBridge, CANRPT and CANCOM configuration. The package runs a bundled Qt console subprocess, which uses WIICAN. It does not require a GUI installation or a separately installed Qt runtime.

0.1.0a1 is a prerelease. Windows wheels are tested with Python 3.8 x86 and Python 3.12 x64; both run the bundled x86 runtime as a separate process. The Linux x86_64 wheel requires glibc 2.38 or later and was built/tested on Ubuntu 24.04 with Python 3.12 and Qt 5.15.13. The bundled runtime contains Console, WIICAN and the required Qt/shared libraries. Consult VALIDATION.md and the release evidence for installation checks. ARM64, macOS and musl are not supported.

canconfig / Python Client
    -> CANConfigConsole.exe + WIICAN.dll           (Windows)
    -> CANConfigConsole + libWIICAN.so.1           (Linux)

First use

Until the project is uploaded, install the supplied local wheel:

python -m pip install path/to/canconfigpython-0.1.0a1-py3-none-win_amd64.whl
canconfig --version --json
canconfig doctor --json
canconfig docs export --output ./canconfig-docs
canconfig skill export --output ./canconfig-skill

After publication, use python -m pip install --pre CANConfigPython. doctor, schema, validate and firmware --dry-run do not open hardware. Configuration info and --dry-run do connect and may change the device run mode.

• 中文使用说明
• English user guide
• Agent Skill
• Build and release
• Validation record
• Third-party notices

Python API

from canconfigpython import Client, ConfigError

client = Client()
try:
    result = client.execute("info", port="COM3")  # Linux: /dev/serial/by-id/...
except ConfigError as error:
    print(error.code, error.message)
else:
    print(result["exit_code"], result["effects"], result["verification"])

execute(command, password=..., new_password=..., **options) uses snake_case options such as expect_uid, dry_run, and timeout_ms; its command names match the CLI. Provide passwords from a secret store or prompt, not source code. Backend failures return the full result; callers must check ok and exit_code. Local validation/runtime errors raise ConfigError. The wrapper does not retry.

The Python layer uses only the standard library. Python 3.8+ is supported by syntax; see the validation record for interpreter versions actually tested.

License

The Python wrapper and project additions are MIT. The bundled Console incorporates XinLi's GPL-3.0-or-later Ymodem implementation and is distributed under that license. Its corresponding project source is included in every wheel as canconfigpython/resources/docs/native-source.tar.gz (also exported by canconfig docs export). Qt and compiler runtime components retain their own licenses. Materials and rebuild instructions are in THIRD_PARTY_NOTICES.md. A runtime manifest checks bundle consistency; it is not a publisher signature.