Metadata-Version: 2.1
Name: arxml
Version: 0.3.0
Summary: Python AUTOSAR XML parser
License: The MIT License (MIT)
        
        Copyright (c) 2016-2021 Conny Gustafsson
        Copyright (c) 2023 Sheetlar (changes after repo fork)
        
        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.
        
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE

AUTOSAR
-------

Python  `AUTOSAR <https://www.autosar.org/>`_ XML parser.

AUTOSAR version support
-----------------------

* AUTOSAR 3.0
* AUTOSAR 4.2

Requirements
------------

* `Python 3.11 <https://www.python.org/>`_

Documentation
-------------

To parse ARXML file, use ``parse_arxml`` function
from ``autosar.extractor.parse_arxml``

Provide it with ``pathlib.Path`` to ARXML file you want to parse.
You will receive a tuple of ``ExtractedSystem`` elements.

``ExtractedSystem`` object consist of:

* ``System`` that was extracted
* A tuple of FIBEX elements the system defines
* SOME/IP service ID, method ID and interface version mapping to name/structure tuple
* Source IP address and port to ECU mapping
