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).
GUI version
udsdoc --serve # opens http://127.0.0.1:8765
- 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 --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). - Outputs —
--format pdf/--pdf(Tex → PDF),--format pdx(ISO 22901-1 PDX; alsotex,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")
LLM configuration
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 asANTHROPIC_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"}).
--verify alone runs fully offline (deterministic status / numeric / lexical
checks); add --verify-llm to let the LLM judge the prose-ambiguous rows.
License
MIT
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file udsdoc-0.99.0.tar.gz.
File metadata
- Download URL: udsdoc-0.99.0.tar.gz
- Upload date:
- Size: 2.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9aef4bc32cc2baf92f96b566fede05c484d24ab3049ed443a65d5bcc2d2ddcf3
|
|
| MD5 |
2a705db82d12cdd062399efde7282953
|
|
| BLAKE2b-256 |
08653c735a32447c58432787af631de2716fdd8ca211fddb93e56ef4d57f0095
|
File details
Details for the file udsdoc-0.99.0-py3-none-any.whl.
File metadata
- Download URL: udsdoc-0.99.0-py3-none-any.whl
- Upload date:
- Size: 2.0 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
99d9be7ee4c940159d14263459ddc9047c1ba96e4dc64a7a805d785f46ef0c43
|
|
| MD5 |
93dffebc7cf900516855d08d2d04e851
|
|
| BLAKE2b-256 |
9fcca631f9b9e358a3ad07c4987b8fba33bf916c7e6bba1db97a0abd71b4aa6d
|
