# 1. py-armodel
## 1.1. Purpose
To support AUTOSAR model with python
## 1.2. Reference Documents
1. AUTOSAR_TPS_XMLSchemaProductionRules.pdf
2. AUTOSAR_TPS_ARXMLSerializationRules.pdf
|Version|Documentation|Travis CI|Coverage Status|Pypi|
|--|--|--|--|--|
|[](https://badge.fury.io/gh/melodypapa%2Fpy-armodel)|[](https://py-armodel.readthedocs.io/en/latest)|[](https://www.travis-ci.com/melodypapa/py-armodel)|[](https://coveralls.io/github/melodypapa/py-armodel?branch=main)|[](https://badge.fury.io/py/armodel)|
## 1.3. How to create the distribution and upload to pypi
1. Run `python setup.py bdist_wheel` to generate distribution
2. Run `twine check dist/*` to check the validation of distribution
3. Run `twine upload dist/*` to upload to pypi repository
4. Check the website https://pypi.org/project/armodel/ to find out it works or not
And more details can be found at https://packaging.python.org/
## 1.4. How to perform Unit test
* Run `pip install pytest pytest-cov` to install pytest.
* Run `pytest --cov=armodel --cov-report term-missing` to verify all the functionality.
## 1.5. How to create a distribution and wheel
* Run `python setup.py sdist bdist_wheel --universal`
## 1.6. How to create the document
1. Run `pip install sphinx` to install the necessary document
## 1.7. Heritage
```
- ARObject
- Referrable
- MultilanguageReferrable
- Identifiable
- PackageableElement
- ARElement
- AtpType
- AutosarDataType
- PortInterface
- DataInterface
- NvDataInterface
- ParameterInterface
- SenderReceiverInterface
- BswModuleEntry
- Implementation
- BswImplementation
- AtpFeature
- AtpPrototype
- AtpPrototype
- DataPrototype
- AutosarDataPrototype
- VariableDataPrototype
- ApplicationCompositeElementDataPrototype
- ApplicationArrayElement
- ApplicationRecordElement
- AtpStructureElement
- BswModuleDescription
- ExecutableEntity
- SwcBswMapping
- ValueSpecification
- ConstantReference
```
## 1.8. CLI usages
### 1.8.1. arxml-dump
**Dump all the arxml data to screen**
`arxml-dump --arxml arg -h`
--arxml arg The file name of arxml data
-h show the help information
### 1.8.2. Example for arxml-dump
**Dump the arxml data from test1.arxml and test2.arxml**
`arxml-dump --arxml test1.arxml --arxml test2.arxml`
## 1.9. API
### 1.9.1. Constructor
```
ARXMLParser(options={"warning": True})
```
## 1.10. Change notes:
**Version 0.1.1**
Add the ARRAY category support for ImplementationDataType
**Version 0.1.2**
Add the AsynchronousServerCallPoint support for ARXML
**Version 0.1.3**
Fix the attribute intervalType of **Limit** is empty issue.
**Version 1.0.0**
1. Add the logging support
2. Add the <warning> option to disable exception raised.
3. Add the BswMD support
**Version 1.1.0**
1. Add the InitEvent support. (Issue #5)
2. Add the DataReceiveEvent support. (Issue #5)
3. Add the SwcModeSwitchEvent support. (Issue #5)
**Version 1.2.0**
1. Add the SwcImplementation support (Issue #9)
2. Add the integer value for memory section alignment (Issue #9)
3. Remove the required attributes for the Implementation according to the AUTOSAR standard 23R-11. (Issue #9)
4. Change the START-ON-EVENT-REF to optional according to the AUTOSAR standard 23R-11. (Issue #9)
5. Change the HANDLE-OUT-OF-RANGE to optional according to the AUTOSAR standard 23R-11. (Issue #9)
6. Add the SensorActuatorSwComponentType support (Issue #9)
7. Change the CATEGORY of COMPU-METHOD to optional.
8. Change the CAN-BE-INVOKED-CONCURRENTLY to optional.
Raw data
{
"_id": null,
"home_page": "http://github.com/melodypapa/py-armodel",
"name": "armodel",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": null,
"keywords": "AUTOSAR ARXML",
"author": "melodypapa",
"author_email": "melodypapa@outlook.com",
"download_url": null,
"platform": null,
"description": "# 1. py-armodel\r\n\r\n## 1.1. Purpose\r\n\r\nTo support AUTOSAR model with python \r\n\r\n## 1.2. Reference Documents\r\n1. AUTOSAR_TPS_XMLSchemaProductionRules.pdf\r\n2. AUTOSAR_TPS_ARXMLSerializationRules.pdf\r\n\r\n|Version|Documentation|Travis CI|Coverage Status|Pypi|\r\n|--|--|--|--|--|\r\n|[](https://badge.fury.io/gh/melodypapa%2Fpy-armodel)|[](https://py-armodel.readthedocs.io/en/latest)|[](https://www.travis-ci.com/melodypapa/py-armodel)|[](https://coveralls.io/github/melodypapa/py-armodel?branch=main)|[](https://badge.fury.io/py/armodel)|\r\n\r\n## 1.3. How to create the distribution and upload to pypi\r\n1. Run `python setup.py bdist_wheel` to generate distribution\r\n2. Run `twine check dist/*` to check the validation of distribution\r\n3. Run `twine upload dist/*` to upload to pypi repository\r\n4. Check the website https://pypi.org/project/armodel/ to find out it works or not\r\n\r\nAnd more details can be found at https://packaging.python.org/ \r\n\r\n## 1.4. How to perform Unit test\r\n\r\n* Run `pip install pytest pytest-cov` to install pytest.\r\n* Run `pytest --cov=armodel --cov-report term-missing` to verify all the functionality.\r\n\r\n## 1.5. How to create a distribution and wheel\r\n\r\n* Run `python setup.py sdist bdist_wheel --universal`\r\n\r\n## 1.6. How to create the document\r\n\r\n1. Run `pip install sphinx` to install the necessary document\r\n\r\n## 1.7. Heritage \r\n\r\n```\r\n- ARObject\r\n - Referrable\r\n - MultilanguageReferrable\r\n - Identifiable\r\n - PackageableElement\r\n - ARElement\r\n - AtpType\r\n - AutosarDataType\r\n - PortInterface\r\n - DataInterface\r\n - NvDataInterface\r\n - ParameterInterface\r\n - SenderReceiverInterface\r\n - BswModuleEntry\r\n - Implementation\r\n - BswImplementation\r\n - AtpFeature\r\n - AtpPrototype\r\n - AtpPrototype\r\n - DataPrototype\r\n - AutosarDataPrototype\r\n - VariableDataPrototype\r\n - ApplicationCompositeElementDataPrototype\r\n - ApplicationArrayElement\r\n - ApplicationRecordElement\r\n - AtpStructureElement\r\n - BswModuleDescription\r\n - ExecutableEntity\r\n - SwcBswMapping\r\n - ValueSpecification\r\n - ConstantReference\r\n```\r\n\r\n## 1.8. CLI usages\r\n\r\n### 1.8.1. arxml-dump\r\n\r\n**Dump all the arxml data to screen**\r\n\r\n`arxml-dump --arxml arg -h`\r\n\r\n--arxml arg The file name of arxml data\r\n\r\n-h show the help information\r\n\r\n### 1.8.2. Example for arxml-dump\r\n\r\n**Dump the arxml data from test1.arxml and test2.arxml**\r\n\r\n`arxml-dump --arxml test1.arxml --arxml test2.arxml`\r\n\r\n## 1.9. API\r\n\r\n### 1.9.1. Constructor\r\n\r\n```\r\n ARXMLParser(options={\"warning\": True})\r\n```\r\n\r\n## 1.10. Change notes:\r\n\r\n**Version 0.1.1**\r\n\r\nAdd the ARRAY category support for ImplementationDataType\r\n\r\n**Version 0.1.2**\r\n\r\nAdd the AsynchronousServerCallPoint support for ARXML\r\n\r\n**Version 0.1.3**\r\n\r\nFix the attribute intervalType of **Limit** is empty issue.\r\n\r\n**Version 1.0.0**\r\n\r\n1. Add the logging support\r\n2. Add the <warning> option to disable exception raised.\r\n3. Add the BswMD support\r\n\r\n**Version 1.1.0**\r\n\r\n1. Add the InitEvent support. (Issue #5)\r\n2. Add the DataReceiveEvent support. (Issue #5)\r\n3. Add the SwcModeSwitchEvent support. (Issue #5)\r\n\r\n**Version 1.2.0**\r\n\r\n1. Add the SwcImplementation support (Issue #9)\r\n2. Add the integer value for memory section alignment (Issue #9)\r\n3. Remove the required attributes for the Implementation according to the AUTOSAR standard 23R-11. (Issue #9)\r\n4. Change the START-ON-EVENT-REF to optional according to the AUTOSAR standard 23R-11. (Issue #9)\r\n5. Change the HANDLE-OUT-OF-RANGE to optional according to the AUTOSAR standard 23R-11. (Issue #9)\r\n6. Add the SensorActuatorSwComponentType support (Issue #9)\r\n7. Change the CATEGORY of COMPU-METHOD to optional.\r\n8. Change the CAN-BE-INVOKED-CONCURRENTLY to optional.\r\n\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "the python arxml parser",
"version": "1.2.0",
"project_urls": {
"Homepage": "http://github.com/melodypapa/py-armodel"
},
"split_keywords": [
"autosar",
"arxml"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3fd70316353ac828eae6d289c8f9e4304acf8c60f843138b721a8f99576288ac",
"md5": "c546b25045ae20a98a9a32059fa13664",
"sha256": "7afd9bb31d61bed158f97c239afba60a282f220eddc988ff0b6271dbbe9d6abf"
},
"downloads": -1,
"filename": "armodel-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c546b25045ae20a98a9a32059fa13664",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 33606,
"upload_time": "2024-04-16T23:42:59",
"upload_time_iso_8601": "2024-04-16T23:42:59.585923Z",
"url": "https://files.pythonhosted.org/packages/3f/d7/0316353ac828eae6d289c8f9e4304acf8c60f843138b721a8f99576288ac/armodel-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 23:42:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "melodypapa",
"github_project": "py-armodel",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "armodel"
}
JSON
