udsxml2tex 0.1.0__tar.gz

udsxml2tex-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 udsxml2tex contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

udsxml2tex-0.1.0/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: udsxml2tex
+Version: 0.1.0
+Summary: Convert AUTOSAR DCM arxml to LaTeX UDS specification documents
+Author: udsxml2tex contributors
+License: MIT
+Project-URL: Homepage, https://github.com/udsxml2tex/udsxml2tex
+Project-URL: Repository, https://github.com/udsxml2tex/udsxml2tex
+Keywords: autosar,arxml,uds,dcm,latex,tex,diagnostics
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Text Processing :: Markup :: LaTeX
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lxml>=4.9.0
+Requires-Dist: Jinja2>=3.1.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Dynamic: license-file
+
+# udsxml2tex
+
+**Convert AUTOSAR DCM arxml to LaTeX UDS specification documents**
+
+A Python library that parses AUTOSAR DCM (Diagnostic Communication Manager) arxml configuration files and automatically generates ISO 14229 (UDS: Unified Diagnostic Services) specification documents in LaTeX format.
+
+## Features
+
+- Automatically extracts UDS specification data from DCM arxml files
+  - Diagnostic sessions
+  - Security access levels
+  - UDS service list (SID, supported sessions, NRCs, etc.)
+  - DID (Data Identifier) definitions
+  - Routine Control definitions
+- Generates professional LaTeX specification documents
+- Customizable via Jinja2 templates
+- Available as both a CLI command and a Python API
+- Supports merging multiple arxml files
+
+## Installation
+
+```bash
+pip install udsxml2tex
+```
+
+From source (for development):
+
+```bash
+git clone https://github.com/udsxml2tex/udsxml2tex.git
+cd udsxml2tex
+pip install -e ".[dev]"
+```
+
+## Usage
+
+### CLI
+
+```bash
+# Basic conversion
+udsxml2tex input.arxml
+
+# Specify output file
+udsxml2tex input.arxml -o output.tex
+
+# Override ECU name
+udsxml2tex input.arxml --ecu-name "MyECU"
+
+# Merge and convert multiple files
+udsxml2tex dcm_config.arxml dcm_dids.arxml -o merged_spec.tex
+
+# Verbose logging
+udsxml2tex input.arxml -v
+```
+
+### Python API
+
+```python
+from udsxml2tex import ArxmlParser, TexGenerator
+
+# Parse ARXML
+parser = ArxmlParser()
+spec = parser.parse("path/to/dcm_config.arxml")
+
+# Generate LaTeX
+generator = TexGenerator()
+generator.generate(spec, "output/uds_spec.tex")
+
+# Get as string
+tex_content = generator.generate_string(spec)
+```
+
+### Custom Templates
+
+You can use your own LaTeX templates:
+
+```python
+generator = TexGenerator(template_dir="my_templates/")
+generator.generate(spec, "output.tex", template_name="custom.tex.j2")
+```
+
+```bash
+udsxml2tex input.arxml --template-dir my_templates/ --template custom.tex.j2
+```
+
+## Generated Document Structure
+
+1. **Title Page** — ECU name, date
+2. **Table of Contents**
+3. **Document Overview** — Protocol information, CAN IDs
+4. **Diagnostic Sessions** — Session list (ID, P2/P2* timers)
+5. **Security Access** — Security level list
+6. **UDS Services** — Service overview + detailed per-service info (including NRCs)
+7. **DID Definitions** — DID overview + data element details
+8. **Routine Control** — Routine overview + parameter details
+
+## Supported arxml Structure
+
+The following AUTOSAR DCM configuration elements are parsed:
+
+| Element | Description |
+|---------|-------------|
+| `DcmDsl` | Diagnostic Session Layer (protocol, timing) |
+| `DcmDsp` | Diagnostic Service Processing (sessions, security, DIDs, routines) |
+| `DcmDsd` | Diagnostic Service Dispatcher (service table) |
+
+Supports AUTOSAR R4.x arxml format.
+
+## Requirements
+
+- Python >= 3.9
+- lxml >= 4.9.0
+- Jinja2 >= 3.1.0
+- LaTeX distribution (for compiling the generated .tex files)
+
+## License
+
+MIT License

udsxml2tex-0.1.0/README.md

@@ -0,0 +1,117 @@
+# udsxml2tex
+
+**Convert AUTOSAR DCM arxml to LaTeX UDS specification documents**
+
+A Python library that parses AUTOSAR DCM (Diagnostic Communication Manager) arxml configuration files and automatically generates ISO 14229 (UDS: Unified Diagnostic Services) specification documents in LaTeX format.
+
+## Features
+
+- Automatically extracts UDS specification data from DCM arxml files
+  - Diagnostic sessions
+  - Security access levels
+  - UDS service list (SID, supported sessions, NRCs, etc.)
+  - DID (Data Identifier) definitions
+  - Routine Control definitions
+- Generates professional LaTeX specification documents
+- Customizable via Jinja2 templates
+- Available as both a CLI command and a Python API
+- Supports merging multiple arxml files
+
+## Installation
+
+```bash
+pip install udsxml2tex
+```
+
+From source (for development):
+
+```bash
+git clone https://github.com/udsxml2tex/udsxml2tex.git
+cd udsxml2tex
+pip install -e ".[dev]"
+```
+
+## Usage
+
+### CLI
+
+```bash
+# Basic conversion
+udsxml2tex input.arxml
+
+# Specify output file
+udsxml2tex input.arxml -o output.tex
+
+# Override ECU name
+udsxml2tex input.arxml --ecu-name "MyECU"
+
+# Merge and convert multiple files
+udsxml2tex dcm_config.arxml dcm_dids.arxml -o merged_spec.tex
+
+# Verbose logging
+udsxml2tex input.arxml -v
+```
+
+### Python API
+
+```python
+from udsxml2tex import ArxmlParser, TexGenerator
+
+# Parse ARXML
+parser = ArxmlParser()
+spec = parser.parse("path/to/dcm_config.arxml")
+
+# Generate LaTeX
+generator = TexGenerator()
+generator.generate(spec, "output/uds_spec.tex")
+
+# Get as string
+tex_content = generator.generate_string(spec)
+```
+
+### Custom Templates
+
+You can use your own LaTeX templates:
+
+```python
+generator = TexGenerator(template_dir="my_templates/")
+generator.generate(spec, "output.tex", template_name="custom.tex.j2")
+```
+
+```bash
+udsxml2tex input.arxml --template-dir my_templates/ --template custom.tex.j2
+```
+
+## Generated Document Structure
+
+1. **Title Page** — ECU name, date
+2. **Table of Contents**
+3. **Document Overview** — Protocol information, CAN IDs
+4. **Diagnostic Sessions** — Session list (ID, P2/P2* timers)
+5. **Security Access** — Security level list
+6. **UDS Services** — Service overview + detailed per-service info (including NRCs)
+7. **DID Definitions** — DID overview + data element details
+8. **Routine Control** — Routine overview + parameter details
+
+## Supported arxml Structure
+
+The following AUTOSAR DCM configuration elements are parsed:
+
+| Element | Description |
+|---------|-------------|
+| `DcmDsl` | Diagnostic Session Layer (protocol, timing) |
+| `DcmDsp` | Diagnostic Service Processing (sessions, security, DIDs, routines) |
+| `DcmDsd` | Diagnostic Service Dispatcher (service table) |
+
+Supports AUTOSAR R4.x arxml format.
+
+## Requirements
+
+- Python >= 3.9
+- lxml >= 4.9.0
+- Jinja2 >= 3.1.0
+- LaTeX distribution (for compiling the generated .tex files)
+
+## License
+
+MIT License

udsxml2tex-0.1.0/pyproject.toml

@@ -0,0 +1,54 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "udsxml2tex"
+version = "0.1.0"
+description = "Convert AUTOSAR DCM arxml to LaTeX UDS specification documents"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.9"
+authors = [
+    {name = "udsxml2tex contributors"},
+]
+keywords = ["autosar", "arxml", "uds", "dcm", "latex", "tex", "diagnostics"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Documentation",
+    "Topic :: Text Processing :: Markup :: LaTeX",
+]
+dependencies = [
+    "lxml>=4.9.0",
+    "Jinja2>=3.1.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+]
+
+[project.scripts]
+udsxml2tex = "udsxml2tex.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/udsxml2tex/udsxml2tex"
+Repository = "https://github.com/udsxml2tex/udsxml2tex"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+udsxml2tex = ["templates/*.tex.j2"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

udsxml2tex-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

udsxml2tex-0.1.0/src/udsxml2tex/__init__.py

@@ -0,0 +1,33 @@
+"""udsxml2tex - Convert AUTOSAR DCM arxml to LaTeX UDS specification documents."""
+
+__version__ = "0.1.0"
+
+from udsxml2tex.generator import TexGenerator
+from udsxml2tex.models import (
+    DataElement,
+    DiagSession,
+    Did,
+    NrcEntry,
+    Routine,
+    RoutineParameter,
+    SecurityLevel,
+    SubFunction,
+    UdsService,
+    UdsSpecification,
+)
+from udsxml2tex.parser import ArxmlParser
+
+__all__ = [
+    "ArxmlParser",
+    "TexGenerator",
+    "UdsSpecification",
+    "UdsService",
+    "DiagSession",
+    "SecurityLevel",
+    "Did",
+    "DataElement",
+    "Routine",
+    "RoutineParameter",
+    "SubFunction",
+    "NrcEntry",
+]

udsxml2tex-0.1.0/src/udsxml2tex/__main__.py

@@ -0,0 +1,7 @@
+"""Allow running udsxml2tex as ``python -m udsxml2tex``."""
+
+import sys
+
+from udsxml2tex.cli import main
+
+sys.exit(main())

udsxml2tex-0.1.0/src/udsxml2tex/cli.py

@@ -0,0 +1,126 @@
+"""Command-line interface for udsxml2tex."""
+
+from __future__ import annotations
+
+import argparse
+import logging
+import sys
+from pathlib import Path
+
+from udsxml2tex.generator import TexGenerator
+from udsxml2tex.parser import ArxmlParser
+
+
+def _build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog="udsxml2tex",
+        description="Convert AUTOSAR DCM arxml to LaTeX UDS specification documents.",
+    )
+    parser.add_argument(
+        "input",
+        nargs="+",
+        help="Input ARXML file(s). Multiple files will be merged.",
+    )
+    parser.add_argument(
+        "-o",
+        "--output",
+        default=None,
+        help="Output .tex file path. Default: <input_stem>_uds_spec.tex",
+    )
+    parser.add_argument(
+        "--ecu-name",
+        default=None,
+        help="Override ECU name in the generated document.",
+    )
+    parser.add_argument(
+        "--template-dir",
+        default=None,
+        help="Directory containing custom Jinja2 LaTeX templates.",
+    )
+    parser.add_argument(
+        "--template",
+        default="uds_spec.tex.j2",
+        help="Template file name (default: uds_spec.tex.j2).",
+    )
+    parser.add_argument(
+        "-v",
+        "--verbose",
+        action="store_true",
+        help="Enable verbose logging output.",
+    )
+    parser.add_argument(
+        "--version",
+        action="version",
+        version="%(prog)s 0.1.0",
+    )
+    return parser
+
+
+def main(argv: list[str] | None = None) -> int:
+    """Main entry point for the CLI.
+
+    Args:
+        argv: Command-line arguments. Defaults to sys.argv[1:].
+
+    Returns:
+        Exit code (0 for success).
+    """
+    parser = _build_parser()
+    args = parser.parse_args(argv)
+
+    # Configure logging
+    level = logging.DEBUG if args.verbose else logging.INFO
+    logging.basicConfig(
+        level=level,
+        format="%(levelname)s: %(message)s",
+    )
+
+    # Validate input files
+    input_paths = [Path(p) for p in args.input]
+    for p in input_paths:
+        if not p.exists():
+            logging.error("Input file not found: %s", p)
+            return 1
+        if not p.suffix.lower() == ".arxml":
+            logging.warning(
+                "File does not have .arxml extension: %s", p
+            )
+
+    # Determine output path
+    if args.output:
+        output_path = Path(args.output)
+    else:
+        stem = input_paths[0].stem
+        output_path = input_paths[0].parent / f"{stem}_uds_spec.tex"
+
+    # Parse ARXML
+    arxml_parser = ArxmlParser()
+    try:
+        if len(input_paths) == 1:
+            spec = arxml_parser.parse(input_paths[0])
+        else:
+            spec = arxml_parser.parse_multi(input_paths)
+    except Exception as e:
+        logging.error("Failed to parse ARXML: %s", e)
+        return 1
+
+    # Override ECU name if specified
+    if args.ecu_name:
+        spec.ecu_name = args.ecu_name
+
+    # Generate LaTeX
+    try:
+        tex_gen = TexGenerator(template_dir=args.template_dir)
+        result = tex_gen.generate(
+            spec, output_path, template_name=args.template
+        )
+        logging.info("Output written to: %s", result)
+    except Exception as e:
+        logging.error("Failed to generate LaTeX: %s", e)
+        return 1
+
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

udsxml2tex-0.1.0/src/udsxml2tex/generator.py

@@ -0,0 +1,165 @@
+"""LaTeX generator for UDS specification documents."""
+
+from __future__ import annotations
+
+import logging
+from pathlib import Path
+from typing import Optional
+
+from jinja2 import Environment, FileSystemLoader, select_autoescape
+
+from udsxml2tex.models import UdsSpecification
+
+logger = logging.getLogger(__name__)
+
+# Characters that need escaping in LaTeX
+_LATEX_ESCAPE_MAP = {
+    "&": r"\&",
+    "%": r"\%",
+    "$": r"\$",
+    "#": r"\#",
+    "_": r"\_",
+    "{": r"\{",
+    "}": r"\}",
+    "~": r"\textasciitilde{}",
+    "^": r"\textasciicircum{}",
+}
+
+
+def _latex_escape(text: str) -> str:
+    """Escape special LaTeX characters in text."""
+    if not text:
+        return ""
+    # Don't escape backslashes that are already LaTeX commands
+    result = []
+    i = 0
+    while i < len(text):
+        ch = text[i]
+        if ch == "\\" and i + 1 < len(text) and text[i + 1].isalpha():
+            # Likely a LaTeX command, don't escape
+            result.append(ch)
+        elif ch in _LATEX_ESCAPE_MAP:
+            result.append(_LATEX_ESCAPE_MAP[ch])
+        else:
+            result.append(ch)
+        i += 1
+    return "".join(result)
+
+
+class TexGenerator:
+    """Generate LaTeX documents from UDS specification data."""
+
+    def __init__(self, template_dir: Optional[str | Path] = None) -> None:
+        """Initialize the TeX generator.
+
+        Args:
+            template_dir: Directory containing Jinja2 templates.
+                         Defaults to the built-in templates directory.
+        """
+        if template_dir is None:
+            template_dir = Path(__file__).parent / "templates"
+        else:
+            template_dir = Path(template_dir)
+
+        self.template_dir = template_dir
+        self.env = Environment(
+            loader=FileSystemLoader(str(template_dir)),
+            block_start_string=r"\BLOCK{",
+            block_end_string="}",
+            variable_start_string=r"\VAR{",
+            variable_end_string="}",
+            comment_start_string=r"\#{",
+            comment_end_string="}",
+            autoescape=False,
+            trim_blocks=True,
+            lstrip_blocks=True,
+        )
+        # Register custom filters
+        self.env.filters["latex_escape"] = _latex_escape
+
+    def generate(
+        self,
+        spec: UdsSpecification,
+        output_path: str | Path,
+        template_name: str = "uds_spec.tex.j2",
+    ) -> Path:
+        """Generate a LaTeX document from the UDS specification.
+
+        Args:
+            spec: The UDS specification data.
+            output_path: Path for the output .tex file.
+            template_name: Name of the Jinja2 template to use.
+
+        Returns:
+            Path to the generated .tex file.
+        """
+        output_path = Path(output_path)
+        output_path.parent.mkdir(parents=True, exist_ok=True)
+
+        template = self.env.get_template(template_name)
+
+        # Sort data for consistent output
+        services = sorted(spec.services, key=lambda s: s.service_id)
+        dids = sorted(spec.dids, key=lambda d: d.did_id)
+        routines = sorted(spec.routines, key=lambda r: r.routine_id)
+        sessions = sorted(spec.sessions, key=lambda s: s.session_id)
+        security_levels = sorted(spec.security_levels, key=lambda s: s.security_level)
+
+        context = {
+            "ecu_name": spec.ecu_name,
+            "description": spec.description,
+            "protocol_name": spec.protocol_name,
+            "can_rx_id": spec.can_rx_id,
+            "can_tx_id": spec.can_tx_id,
+            "can_functional_id": spec.can_functional_id,
+            "sessions": sessions,
+            "security_levels": security_levels,
+            "services": services,
+            "dids": dids,
+            "routines": routines,
+        }
+
+        rendered = template.render(**context)
+
+        output_path.write_text(rendered, encoding="utf-8")
+        logger.info("Generated LaTeX document: %s", output_path)
+
+        return output_path
+
+    def generate_string(
+        self,
+        spec: UdsSpecification,
+        template_name: str = "uds_spec.tex.j2",
+    ) -> str:
+        """Generate LaTeX content as a string.
+
+        Args:
+            spec: The UDS specification data.
+            template_name: Name of the Jinja2 template to use.
+
+        Returns:
+            Rendered LaTeX content.
+        """
+        template = self.env.get_template(template_name)
+
+        services = sorted(spec.services, key=lambda s: s.service_id)
+        dids = sorted(spec.dids, key=lambda d: d.did_id)
+        routines = sorted(spec.routines, key=lambda r: r.routine_id)
+        sessions = sorted(spec.sessions, key=lambda s: s.session_id)
+        security_levels = sorted(spec.security_levels, key=lambda s: s.security_level)
+
+        context = {
+            "ecu_name": spec.ecu_name,
+            "description": spec.description,
+            "protocol_name": spec.protocol_name,
+            "can_rx_id": spec.can_rx_id,
+            "can_tx_id": spec.can_tx_id,
+            "can_functional_id": spec.can_functional_id,
+            "sessions": sessions,
+            "security_levels": security_levels,
+            "services": services,
+            "dids": dids,
+            "routines": routines,
+        }
+
+        return template.render(**context)