udsdoc

AUTOSAR DCM/CanTp/DEM ARXML → UDS (ISO 14229) specification documents (LaTeX → PDF) and ASAM ODX 2.2 / PDX (ISO 22901-1).

udsdoc turns AUTOSAR diagnostic ARXML into a complete UDS specification and into ODX/PDX for diagnostic tooling. It offers two front-ends over the same pipeline: a GUI (local browser app) and a CLI (headless, CI/HPC-friendly).

Install

pip install udsdoc          # CLI core (LaTeX / Markdown / RST / ODX / PDX)
pip install udsdoc[web]     # GUI  (udsdoc --serve)
pip install udsdoc[all]     # everything (GUI + LLM verify + ECU testing)

PDF output needs a LaTeX distribution with xelatex (TeX Live / MiKTeX). No pip on the target machine? Grab the self-contained udsdoc.pyz from Releases — it runs with just a Python interpreter (python3 udsdoc.pyz input.arxml -o spec.tex).

GUI version

udsdoc --serve            # opens http://127.0.0.1:8765

The no-install static browser edition also generates LaTeX/PDX and performs local compliance analysis entirely in the tab. Its Pyodide runtime, Python wheels, WebLLM runtime, and odx-rs WASM are self-hosted and available offline after the first successful load.

For matrix-only SRA/SWA work, the CpM CSV files remain the primary input. The browser edition can optionally take the summary workbook as an answer/reference for the supported SID, DID, RID and DTC surface. It reconciles the CpM-derived surface before generating TeX/PDX; it does not render the workbook itself as a specification.

With an SRA reference, this produces two peer ECU variants (System1 and System2) because SRA is a dual-uC system. IDs whose answer-sheet row has no per-uC allocation are explicitly treated as shared; no routing or gateway is invented. With an SWA reference, output remains a single-uC specification.

Inputs — on the Generate tab, pick a BSW repository folder (or a built-in sample). It auto-discovers the ARXML (Dcm / CanTp / Dem) and the C sources; attach an optional Compliance Matrix CSV (+ a sources YAML) for a requirements-compliance chapter.
Outputs — Generate & Download a LaTeX ZIP that includes a compiled spec.pdf (Tex → PDF), or Export ODX / PDX for CANalyzer / CANoe.
LLM — the LLM tab connects the provider used by Verify Conditionally-Accepted comments: Claude (browser sign-in), ChatGPT / Gemini (paste an API key — the button opens the key page for you), or local Ollama (pick or install an open-source model). Credentials are stored locally under ~/.udsdoc/.

CLI version

# ARXML in → LaTeX + compiled PDF out
udsdoc dcm.arxml cantp.arxml --dem dem.arxml --pdf -o spec.tex

# auto-discover a whole BSW repo (ARXML + C sources)
udsdoc --repo /path/to/bsw-project --pdf -o spec.tex

# DID / RID C sources for variable cross-referencing
udsdoc dcm.arxml --c-source did.c --c-source rid.c -o spec.tex

# Compliance Matrix + verify the concluded OEM↔supplier dialogue vs. the
# implementation, emit ISO 22901-1 PDX
udsdoc dcm.arxml --dem dem.arxml \
  --compliance-matrix matrix.csv --verify --verify-mini \
  --format pdx -o out/spec

Inputs — ARXML as positional arguments (+ --dem), or a whole repository via --repo; C sources via --c-source; requirements via --compliance-matrix (+ --compliance-matrix-sources). The matrix loader accepts the classic req_id/description/source_ref/traces_to contract and real-world OEM/DOORS exports (ID / ObjectType_<proj> / … / CONTENT / AcceptanceState_<proj> / CommentToCustomer_<proj> / Comment_Customer_<proj> / Final_Agreement_Status) — the per-project header tag (_ZFLSRM, …) is stripped automatically, heading/information rows are skipped, and Final_Agreement_Status is honored as the negotiation state (see the compliance_matrix module docstring for the full mapping).
Outputs — --format pdf / --pdf (Tex → PDF), --format pdx (ISO 22901-1 PDX; also tex, tex-zip — the structured multi-file LaTeX project as a ZIP — html, md, rst, odx). Exit codes: 0 ok / 1 runtime error / 2 usage error / 3 quality gate (--verify-strict, --validate, --odx-strict).

Python API:

from udsdoc import ArxmlParser, TexGenerator

spec = ArxmlParser().parse_multi(["dcm.arxml", "cantp.arxml"])
TexGenerator().generate(spec, "spec.tex")

Compliance verification

Verification is a local-first evidence pipeline:

--verify runs deterministic status, trace, numeric, access, and lexical checks with no network access.
--verify-mini adds the opt-in, dependency-free udsdoc-mini-semantic-v1 tier. It uses issue-scoped dialogue chronology, exact parsed-spec evidence, and mandatory abstention.
--verify-llm sends only the unresolved residue to the configured model.

Missing SID/DID/RID/DTC/session/security traces can be inferred from explicitly anchored English or Japanese text. Bare hexadecimal values are ignored, and every inferred trace retains confidence and source evidence. The frozen 90-row compact-model benchmark measures 64.4% coverage, 91.4% accuracy on covered rows, 80.0% deviation precision, and 40.0% deviation recall. The low recall is why uncertain remains a first-class review outcome.

The Verify feature (does the concluded OEM↔supplier dialogue match the implementation?) works with Anthropic (Claude), any OpenAI-compatible endpoint (OpenAI, Gemini's OpenAI-compatible API, OpenRouter, …) or local Ollama. Configure it once, whichever way suits you:

GUI — the LLM tab: sign in with Claude, paste a ChatGPT / Gemini key, or pick an Ollama model.
Env vars — UDSDOC_LLM_PROVIDER, UDSDOC_LLM_MODEL, UDSDOC_LLM_BASE_URL, UDSDOC_LLM_API_KEY (or a provider-native key such as ANTHROPIC_API_KEY / OPENAI_API_KEY / GEMINI_API_KEY).
CLI flags — --llm-provider, --llm-model, --llm-base-url, --llm-api-key, or --llm-config <file>.
Config file — ~/.udsdoc/llm.json ({"provider", "model", "base_url", "api_key", "timeout"}).

The static browser edition does not expose remote API-key providers. It can send uncertain rows to Ollama at the fixed loopback endpoint 127.0.0.1:11434, or run a consent-loaded WebLLM model in the browser. Model weights are not bundled. See the local-AI architecture and privacy contract for data-flow, offline, grounding, and reproducible benchmark details.

License

MIT

Download files

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

Source Distribution

udsdoc-0.174.0.tar.gz (2.4 MB view details)

Uploaded Aug 5, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

udsdoc-0.174.0-py3-none-any.whl (2.2 MB view details)

Uploaded Aug 5, 2026 Python 3

File details

Details for the file udsdoc-0.174.0.tar.gz.

File metadata

Download URL: udsdoc-0.174.0.tar.gz
Upload date: Aug 5, 2026
Size: 2.4 MB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for udsdoc-0.174.0.tar.gz
Algorithm	Hash digest
SHA256	`e40a22b280a4d77e3d4faf1035ae6d80726365d79ed95a340c37b988950e831d`
MD5	`4df14c8f05ff8173373c2fcb75086c91`
BLAKE2b-256	`cefdefec4d9ac5dfcf14eb9239a34228fba3ad152572ff4258848c152f8f544d`

See more details on using hashes here.

Provenance

The following attestation bundles were made for udsdoc-0.174.0.tar.gz:

Publisher: udsdoc-ci.yml on YutaroNakagama/udsdoc

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

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: udsdoc-0.174.0.tar.gz
- Subject digest: e40a22b280a4d77e3d4faf1035ae6d80726365d79ed95a340c37b988950e831d
- Sigstore transparency entry: 2345631183
- Sigstore integration time: Aug 5, 2026
Source repository:
- Permalink: YutaroNakagama/udsdoc@8a2562bb78dc5810b8ba991a2aca202e79590b0e
- Branch / Tag: refs/tags/v0.174.0
- Owner: https://github.com/YutaroNakagama
- Access: private
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: udsdoc-ci.yml@8a2562bb78dc5810b8ba991a2aca202e79590b0e
- Trigger Event: push