# 1. Map Reporter
## 1.1. Introduce
The utility to generate the report for Greenhill (GHS) map file
### 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.2. CLI
```
map-analyzer -c toml/meths.toml -m map/ghs/ghs.map --excel ghs.xlsx
```
```
map-analyzer -c toml/propa.toml -m map/ghs/propa.map --excel propa.xlsx
```
## 1.3. Change notes
**0.1.0**
1. Parse the green-hill map format.
2. Collect the .a file as the module.
3. Export the report into xlsx file.
**0.1.1**
1. Add the supporting of NXP G32G GCC map format.
2. Read the memory section in the GHS map format.
3. Add the ROM/RAM/Calibration attribute for the memory section.
4. Output the memory section in the excel file.
**0.2.1**
1. Add the section report.
2. Add the section summary.
Raw data
{
"_id": null,
"home_page": "https://github.com/melodypapa/py-map-analyzer",
"name": "map-analyzer",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "GHS Map",
"author": "Melodypapa",
"author_email": "melodypapa@outlook.com",
"download_url": "",
"platform": null,
"description": "# 1. Map Reporter\n\n## 1.1. Introduce\n\nThe utility to generate the report for Greenhill (GHS) map file\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.2. CLI\n\n```\nmap-analyzer -c toml/meths.toml -m map/ghs/ghs.map --excel ghs.xlsx\n```\n\n```\nmap-analyzer -c toml/propa.toml -m map/ghs/propa.map --excel propa.xlsx\n```\n\n## 1.3. Change notes\n\n**0.1.0**\n\n1. Parse the green-hill map format.\n2. Collect the .a file as the module.\n3. Export the report into xlsx file.\n\n\n**0.1.1**\n\n1. Add the supporting of NXP G32G GCC map format.\n2. Read the memory section in the GHS map format.\n3. Add the ROM/RAM/Calibration attribute for the memory section.\n4. Output the memory section in the excel file.\n\n**0.2.1**\n\n1. Add the section report.\n2. Add the section summary.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python tool for GHS map analysis",
"version": "0.2.1",
"split_keywords": [
"ghs",
"map"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a66e074521d4f25acb2eb614c8ea4026a474ac0a1f72ca3cee58d4f58f090e34",
"md5": "e44368e87b35b33ceddcb7eadc129164",
"sha256": "adca1f87d6dabbabec4ee190119db7aab68ff7e0a23baf84ad013abb2b9854eb"
},
"downloads": -1,
"filename": "map_analyzer-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e44368e87b35b33ceddcb7eadc129164",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 14116,
"upload_time": "2023-03-12T02:03:55",
"upload_time_iso_8601": "2023-03-12T02:03:55.459182Z",
"url": "https://files.pythonhosted.org/packages/a6/6e/074521d4f25acb2eb614c8ea4026a474ac0a1f72ca3cee58d4f58f090e34/map_analyzer-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-12 02:03:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "melodypapa",
"github_project": "py-map-analyzer",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "map-analyzer"
}
JSON
