| Name | py-tresos JSON |
| Version |
1.2.1
JSON |
| download |
| home_page | |
| Summary | A Python tool for EB Tresos Studio Plugins |
| upload_time | 2023-09-08 03:47:10 |
| maintainer | |
| docs_url | None |
| author | Melodypapa |
| requires_python | >=3.5 |
| license | MIT |
| keywords |
eb
tresos
plugin
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 1. py-tresos
## 1.1. Introduce
The utility is the python script supporting tool for EB Tresos Studio
### 1.1.1. 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.1.2. Unit test
Run `pip install pytest pytest-cov` to install pytest.
Run `pytest --cov=py_tresos --cov-report term-missing` to verify all the functionality.
### 1.1.3. How to create the document
1. Run `pip install sphinx` to install the necessary document
## 1.2. eb-plugin
To Create the java project for the EB Tresos Studio Plugin.
### 1.2.1. TOML configuration
| Category | Key | Description |
| --------- | ---------------- | ----------------------------------------------------------------------- |
| component | name | the plugin name |
| | author | the author's name of the plugin |
| | company | the company owner for the plugin |
| | version | the version of the plugin |
| | ar_version | the AUTOSAR version of the plugin |
| | vendor_id | the [vender Id](https://www.autosar.org/about/vendorid/) for the plugin |
| | ar_package | the root package for the ARXML |
| | header_files | the header file name list for the plugin |
| | source_files | the source file name list for the plugin |
| | gen_header_files | the generated head file name list for the plugin |
| | gen_source_files | the generate source file name list for the plugin |
| | tresos_root | the root path for the EB Tresos Studios |
| template | source_file | the template name for the source file |
| | header_file | the template name for the header file |
### 1.2.2. TOML configuration example
```
[component]
name = "Plugin_Demo"
author = "Your Name"
company = "Your Company"
version = "1.0.0"
ar_version = "4.0.3"
vendor_id = "0x0008"
ar_package = "ARRoot"
header_files = [
"Plugin_Demo.h"
]
source_files = [
"Plugin_Demo.c"
]
gen_header_files = [
"Plugin_Demo_Cfg.h",
]
gen_source_files = [
"Plugin_Demo_Cfg.c",
]
tresos_root = "X:/tresos"
[template]
source_file = ""
header_file = ""
```
### 1.2.3. CLI
`eb-plugin [-c|--cfg name][-h|-help]`
```
-c|--cfg name : The TOML configure file name
-h : Show the help information.
```
### 1.2.4. Example
**Generate the default folder for Plugin Demo**
```
eb-plugin -c toml/plugin_demo.toml
```
## 1.3. eb-xpath
To Create the java project for the EB Tresos Studio XPath Plugin.
### 1.3.1. TOML configuration
| Category | Key | Description |
| --------- | ---------- | ------------------------------------ |
| component | name | the plugin name |
| | author | the author's name of the plugin |
| | company | the company owner for the plugin |
| | version | the version of the plugin |
| | ar_version | the AUTOSAR version of the plugin |
| java | package | the java package name for the plugin |
| | class | the java class name for the plugin |
### 1.3.2. TOML configuration example
```
[component]
name = "XPath_Demo"
author = "Your Name"
company = "Your name"
version = "1.0.0"
ar_version = "4.0.3"
[java]
package = "org.ecliipse.sdv"
class = "xpath_demo"
```
### 1.3.3. CLI
`eb-xpath [-c|--cfg name][-h|-help]`
```
-c|--cfg name : The TOML configure file name
-h : Show the help information.
```
### 1.3.4. Example
**Generate the default folder for XPath demo**
```
eb-plugin -c toml/xpath_demo.toml
```
## 1.4. Change notes
**1.0.2**
1. The ARXML template can be customized.
**1.1.0**
1. Add the supporting to create XPath Plugin.
**1.2.1**
1. Fix the same generator id for the different version plugin issues.
Raw data
{
"_id": null,
"home_page": "",
"name": "py-tresos",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "EB Tresos Plugin",
"author": "Melodypapa",
"author_email": "melodypapa@outlook.com",
"download_url": "",
"platform": null,
"description": "# 1. py-tresos\n\n## 1.1. Introduce\n\nThe utility is the python script supporting tool for EB Tresos Studio\n\n### 1.1.1. How to create the distribution and upload to pypi\n1. Run `python setup.py bdist_wheel` to generate distribution\n2. Run `twine check dist/*` to check the validation of distribution\n3. Run `twine upload dist/*` to upload to pypi repository\n4. Check the website https://pypi.org/project/armodel/ to find out it works or not\n\nAnd more details can be found at https://packaging.python.org/ \n\n### 1.1.2. Unit test\n\nRun `pip install pytest pytest-cov` to install pytest.\n\nRun `pytest --cov=py_tresos --cov-report term-missing` to verify all the functionality.\n\n### 1.1.3. How to create the document\n\n1. Run `pip install sphinx` to install the necessary document\n\n## 1.2. eb-plugin\n\nTo Create the java project for the EB Tresos Studio Plugin.\n\n### 1.2.1. TOML configuration\n\n| Category | Key | Description |\n| --------- | ---------------- | ----------------------------------------------------------------------- |\n| component | name | the plugin name |\n| | author | the author's name of the plugin |\n| | company | the company owner for the plugin |\n| | version | the version of the plugin |\n| | ar_version | the AUTOSAR version of the plugin |\n| | vendor_id | the [vender Id](https://www.autosar.org/about/vendorid/) for the plugin |\n| | ar_package | the root package for the ARXML |\n| | header_files | the header file name list for the plugin |\n| | source_files | the source file name list for the plugin |\n| | gen_header_files | the generated head file name list for the plugin |\n| | gen_source_files | the generate source file name list for the plugin |\n| | tresos_root | the root path for the EB Tresos Studios |\n| template | source_file | the template name for the source file |\n| | header_file | the template name for the header file |\n\n### 1.2.2. TOML configuration example\n\n```\n[component]\nname = \"Plugin_Demo\"\nauthor = \"Your Name\"\ncompany = \"Your Company\"\nversion = \"1.0.0\"\nar_version = \"4.0.3\"\nvendor_id = \"0x0008\"\nar_package = \"ARRoot\"\n\nheader_files = [\n \"Plugin_Demo.h\"\n]\n\nsource_files = [\n \"Plugin_Demo.c\"\n]\n\ngen_header_files = [\n \"Plugin_Demo_Cfg.h\",\n]\n\ngen_source_files = [\n \"Plugin_Demo_Cfg.c\",\n]\n\ntresos_root = \"X:/tresos\"\n\n[template]\nsource_file = \"\"\nheader_file = \"\"\n``` \n\n### 1.2.3. CLI\n\n`eb-plugin [-c|--cfg name][-h|-help]`\n\n```\n-c|--cfg name : The TOML configure file name\n-h : Show the help information.\n```\n\n### 1.2.4. Example\n\n**Generate the default folder for Plugin Demo**\n\n```\neb-plugin -c toml/plugin_demo.toml\n```\n\n## 1.3. eb-xpath\n\nTo Create the java project for the EB Tresos Studio XPath Plugin.\n\n### 1.3.1. TOML configuration\n\n| Category | Key | Description |\n| --------- | ---------- | ------------------------------------ |\n| component | name | the plugin name |\n| | author | the author's name of the plugin |\n| | company | the company owner for the plugin |\n| | version | the version of the plugin |\n| | ar_version | the AUTOSAR version of the plugin |\n| java | package | the java package name for the plugin |\n| | class | the java class name for the plugin |\n\n### 1.3.2. TOML configuration example\n\n```\n[component]\nname = \"XPath_Demo\"\nauthor = \"Your Name\"\ncompany = \"Your name\"\nversion = \"1.0.0\"\nar_version = \"4.0.3\"\n\n[java]\npackage = \"org.ecliipse.sdv\"\nclass = \"xpath_demo\"\n``` \n\n### 1.3.3. CLI\n\n`eb-xpath [-c|--cfg name][-h|-help]`\n\n```\n-c|--cfg name : The TOML configure file name\n-h : Show the help information.\n```\n\n### 1.3.4. Example\n\n**Generate the default folder for XPath demo**\n\n```\neb-plugin -c toml/xpath_demo.toml\n```\n\n## 1.4. Change notes\n\n**1.0.2**\n\n1. The ARXML template can be customized.\n\n**1.1.0**\n\n1. Add the supporting to create XPath Plugin.\n\n**1.2.1**\n\n1. Fix the same generator id for the different version plugin issues.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python tool for EB Tresos Studio Plugins",
"version": "1.2.1",
"project_urls": null,
"split_keywords": [
"eb",
"tresos",
"plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fc8ff8d70abbff40146990a8af99fd207b6d5932006a910fd62cc19382966953",
"md5": "6d5230c18c0c96319571a38a90cc1409",
"sha256": "af48868f21e2da04e15587a61d556199778b7b48954de59a35aaeebea53f946e"
},
"downloads": -1,
"filename": "py_tresos-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6d5230c18c0c96319571a38a90cc1409",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 37367,
"upload_time": "2023-09-08T03:47:10",
"upload_time_iso_8601": "2023-09-08T03:47:10.712995Z",
"url": "https://files.pythonhosted.org/packages/fc/8f/f8d70abbff40146990a8af99fd207b6d5932006a910fd62cc19382966953/py_tresos-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-08 03:47:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "py-tresos"
}
