<p align="center">
<a title="edaa-org.github.io/pyEDAA.Reports" href="https://edaa-org.github.io/pyEDAA.Reports"><img height="80px" src="doc/_static/logo.svg"/></a>
</p>
[](https://GitHub.com/edaa-org/pyEDAA.Reports)
[](https://edaa-org.github.io/pyEDAA.Reports/)
[](https://gitter.im/hdl/community)
[](https://GitHub.com/edaa-org/pyEDAA.Reports/actions/workflows/Pipeline.yml)
[](https://app.codacy.com/gh/edaa-org/pyEDAA.Reports)
<!--
[](LICENSE.md)
[](LICENSE.md)
[](https://pypi.org/project/pyEDAA.Reports/)
[](https://libraries.io/github/edaa-org/pyEDAA.Reports)
[](https://app.codacy.com/gh/edaa-org/pyEDAA.Reports)
[](https://codecov.io/gh/edaa-org/pyEDAA.Reports)
[](https://GitHub.com/edaa-org/pyEDAA.Reports/network/dependents)
[](https://requires.io/github/EDAA-ORG/pyEDAA.Reports/requirements/?branch=main)
[](https://libraries.io/github/edaa-org/pyEDAA.Reports/sourcerank)
-->
Proposal to define an abstract model for outputs from EDA tools and logging libraries.
The main intended use case of pyEDAA.Reports is to import multiple log/report formats (raw logs, CSVs, YAML, JSON, etc.)
and provide a unified model that can generate reports using popular formats such as XUnit or Cobertura.
Since most vendors, CI services and monitoring tools support XML, the internals of pyEDAA.Reports are to be based on
XML transformations.
As an abstract model, the main capability of pyEDAA.Reports is handling messages using an structured format.
The readers categorize messages by IDs and append attributes such as the severity, which allow complex filtering and
fancy coloring for better human readability.
<p align="center">
<a title="edaa-org.github.io/pyEDAA.Reports" href="https://edaa-org.github.io/pyEDAA.Reports"><img height="275px" src="doc/_static/work-in-progress.png"/></a>
</p>
# Report Kinds
## Test Report Summary
* Test Suite
* Test Case
* Test Parameter
## Code Coverage Report
* Line Coverage
* Statement Coverage
* Branch Coverage
* Expression Coverage
* State Coverage
* Transition Coverage
## Functional Coverage
* Coverage Model
* Dimension
* Bin
* Item
* Range
## Synthesis
* Area/resources
* Timing
## Implementation
* Area/resources
* Timing
# Target input logs/formats
* ActiveHDL
* CoCoTb
* Diamond
* GHDL
* Icarus Verilog
* ISE
* ModelSim/QuestaSim
* nextpnr
* OSVVM
* RivieraPRO
* SymbiYosys
* Synplify
* Quartus
* Verilator
* Verilog-to-Routing
* Vivado
* VUnit
* Xcelium
* Yosys
* ...
# References
* [olofk/edalize](https://github.com/olofk/edalize/) (see `edalize.reporting`, `edalize.vivado_reporting`, `edalize.quartus_reporting`, `edalize.ise_reporting`, ...)
* [librecores/eda-log-parser](https://github.com/librecores/eda-log-parser)
* [SymbiFlow/fpga-tool-perf](https://github.com/SymbiFlow/fpga-tool-perf)
* [mattvenn/logLUTs](https://github.com/mattvenn/logLUTs)
* [tiagolascasas/Vivado-HLS-Report-Parser](https://github.com/tiagolascasas/Vivado-HLS-Report-Parser)
* [cuelang.org/](https://cuelang.org/)
* [cuelang.org/docs/tutorials](https://cuelang.org/docs/tutorials/)
* [cue-lang/cue#162](https://github.com/cue-lang/cue/issues/162)
* [pypi.org/project/pycue](https://pypi.org/project/pycue/)
* [philipdexter/pycue](https://github.com/philipdexter/pycue)
Raw data
{
"_id": null,
"home_page": "https://GitHub.com/pyEDAA/pyEDAA.Reports",
"name": "pyEDAA.Reports",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Reports, Abstract Model, Data Model, Unit Testing, Testcase, Testsuite, OSVVM, YAML, XML",
"author": "Patrick Lehmann",
"author_email": "Paebbels@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b1/d6/da93091412e6df1e0f5b795ed8ea3f14ab3b2a61aafa12da7218c0bfcf25/pyedaa_reports-0.14.1.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a title=\"edaa-org.github.io/pyEDAA.Reports\" href=\"https://edaa-org.github.io/pyEDAA.Reports\"><img height=\"80px\" src=\"doc/_static/logo.svg\"/></a>\n</p>\n\n[](https://GitHub.com/edaa-org/pyEDAA.Reports)\n[](https://edaa-org.github.io/pyEDAA.Reports/)\n[](https://gitter.im/hdl/community) \n[](https://GitHub.com/edaa-org/pyEDAA.Reports/actions/workflows/Pipeline.yml)\n[](https://app.codacy.com/gh/edaa-org/pyEDAA.Reports)\n\n<!--\n[](LICENSE.md)\n[](LICENSE.md)\n\n[](https://pypi.org/project/pyEDAA.Reports/)\n\n\n\n[](https://libraries.io/github/edaa-org/pyEDAA.Reports)\n[](https://app.codacy.com/gh/edaa-org/pyEDAA.Reports)\n[](https://codecov.io/gh/edaa-org/pyEDAA.Reports)\n\n[](https://GitHub.com/edaa-org/pyEDAA.Reports/network/dependents)\n[](https://requires.io/github/EDAA-ORG/pyEDAA.Reports/requirements/?branch=main)\n[](https://libraries.io/github/edaa-org/pyEDAA.Reports/sourcerank)\n-->\n\nProposal to define an abstract model for outputs from EDA tools and logging libraries.\n\nThe main intended use case of pyEDAA.Reports is to import multiple log/report formats (raw logs, CSVs, YAML, JSON, etc.)\nand provide a unified model that can generate reports using popular formats such as XUnit or Cobertura.\nSince most vendors, CI services and monitoring tools support XML, the internals of pyEDAA.Reports are to be based on\nXML transformations.\n\nAs an abstract model, the main capability of pyEDAA.Reports is handling messages using an structured format.\nThe readers categorize messages by IDs and append attributes such as the severity, which allow complex filtering and\nfancy coloring for better human readability.\n\n<p align=\"center\">\n <a title=\"edaa-org.github.io/pyEDAA.Reports\" href=\"https://edaa-org.github.io/pyEDAA.Reports\"><img height=\"275px\" src=\"doc/_static/work-in-progress.png\"/></a>\n</p>\n\n# Report Kinds\n\n## Test Report Summary\n\n* Test Suite\n* Test Case\n* Test Parameter\n\n## Code Coverage Report\n\n* Line Coverage\n* Statement Coverage\n* Branch Coverage\n* Expression Coverage\n* State Coverage\n* Transition Coverage\n\n## Functional Coverage\n\n* Coverage Model\n * Dimension\n * Bin\n * Item\n * Range\n\n## Synthesis\n\n* Area/resources\n* Timing\n\n## Implementation\n\n* Area/resources\n* Timing\n\n# Target input logs/formats\n\n* ActiveHDL\n* CoCoTb\n* Diamond\n* GHDL\n* Icarus Verilog\n* ISE\n* ModelSim/QuestaSim\n* nextpnr\n* OSVVM\n* RivieraPRO\n* SymbiYosys\n* Synplify\n* Quartus\n* Verilator\n* Verilog-to-Routing\n* Vivado\n* VUnit\n* Xcelium\n* Yosys\n* ...\n\n# References\n\n* [olofk/edalize](https://github.com/olofk/edalize/) (see `edalize.reporting`, `edalize.vivado_reporting`, `edalize.quartus_reporting`, `edalize.ise_reporting`, ...)\n* [librecores/eda-log-parser](https://github.com/librecores/eda-log-parser)\n* [SymbiFlow/fpga-tool-perf](https://github.com/SymbiFlow/fpga-tool-perf)\n* [mattvenn/logLUTs](https://github.com/mattvenn/logLUTs)\n* [tiagolascasas/Vivado-HLS-Report-Parser](https://github.com/tiagolascasas/Vivado-HLS-Report-Parser)\n* [cuelang.org/](https://cuelang.org/)\n * [cuelang.org/docs/tutorials](https://cuelang.org/docs/tutorials/)\n * [cue-lang/cue#162](https://github.com/cue-lang/cue/issues/162)\n * [pypi.org/project/pycue](https://pypi.org/project/pycue/)\n * [philipdexter/pycue](https://github.com/philipdexter/pycue)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Various report abstract data models and report format converters.",
"version": "0.14.1",
"project_urls": {
"Documentation": "https://pyEDAA.GitHub.io/pyEDAA.Reports",
"Homepage": "https://GitHub.com/pyEDAA/pyEDAA.Reports",
"Issue Tracker": "https://GitHub.com/pyEDAA/pyEDAA.Reports/issues",
"Source Code": "https://GitHub.com/pyEDAA/pyEDAA.Reports"
},
"split_keywords": [
"reports",
" abstract model",
" data model",
" unit testing",
" testcase",
" testsuite",
" osvvm",
" yaml",
" xml"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a5603afa69ce4bb26ed468ab1913238ec97582fac0e67969220090aafa680e0c",
"md5": "55f15491633ddb2ec8452ad4c4ee0d9f",
"sha256": "75f50be23b0d177b1e501ad49dc3c849121593ff74f6069d046150d3b577227a"
},
"downloads": -1,
"filename": "pyEDAA.Reports-0.14.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "55f15491633ddb2ec8452ad4c4ee0d9f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 79258,
"upload_time": "2024-11-03T17:06:00",
"upload_time_iso_8601": "2024-11-03T17:06:00.141442Z",
"url": "https://files.pythonhosted.org/packages/a5/60/3afa69ce4bb26ed468ab1913238ec97582fac0e67969220090aafa680e0c/pyEDAA.Reports-0.14.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b1d6da93091412e6df1e0f5b795ed8ea3f14ab3b2a61aafa12da7218c0bfcf25",
"md5": "3c5eeff648ed8bb04f579872967a50a6",
"sha256": "9901e312d6223bff99814b5e31986782300affc649a9ba765984744ca7bb3d00"
},
"downloads": -1,
"filename": "pyedaa_reports-0.14.1.tar.gz",
"has_sig": false,
"md5_digest": "3c5eeff648ed8bb04f579872967a50a6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 55444,
"upload_time": "2024-11-03T17:05:58",
"upload_time_iso_8601": "2024-11-03T17:05:58.144150Z",
"url": "https://files.pythonhosted.org/packages/b1/d6/da93091412e6df1e0f5b795ed8ea3f14ab3b2a61aafa12da7218c0bfcf25/pyedaa_reports-0.14.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-03 17:05:58",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyedaa.reports"
}
JSON