<p align="center">
<img src="docs/logo.png">
</p>
<p align="center">
Report generation system for <a href="https://github.com/pwwang/pipen">pipen</a>.
</p>
<hr />
## Installation
```shell
❯ pip install -U pipen-report
# update configurations if needed:
❯ pipen report config
# then update frontend dependencies:
❯ pipen report update
```
## Enabling/Disabling the plugin
The plugin is registered via entrypoints. It's by default enabled. To disable it: `plugins=[..., "no:report"]`, or uninstall this plugin.
## Example
See the pipeline in `example/`, and the reports generated by the pipeline:
[https://pwwang.github.io/pipen-report/example/output/REPORTS][2]
## Documentation
See: [https://pwwang.github.io/pipen-report][3]
[1]: https://github.com/pwwang/pipen
[2]: https://pwwang.github.io/pipen-report/example/output/REPORTS
[3]: https://pwwang.github.io/pipen-report
Raw data
{
"_id": null,
"home_page": "https://github.com/pwwang/pipen-report",
"name": "pipen-report",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "pwwang",
"author_email": "pwwang@pwwang.com",
"download_url": "https://files.pythonhosted.org/packages/30/f6/7e651303170320f0d7334ea6e523bcf43f80cdd433a1ffcc3b0d46b43816/pipen_report-0.21.3.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"docs/logo.png\">\n</p>\n<p align=\"center\">\nReport generation system for <a href=\"https://github.com/pwwang/pipen\">pipen</a>.\n</p>\n<hr />\n\n## Installation\n\n```shell\n\u276f pip install -U pipen-report\n\n# update configurations if needed:\n\u276f pipen report config\n\n# then update frontend dependencies:\n\u276f pipen report update\n```\n\n## Enabling/Disabling the plugin\n\nThe plugin is registered via entrypoints. It's by default enabled. To disable it: `plugins=[..., \"no:report\"]`, or uninstall this plugin.\n\n## Example\n\nSee the pipeline in `example/`, and the reports generated by the pipeline:\n\n[https://pwwang.github.io/pipen-report/example/output/REPORTS][2]\n\n## Documentation\n\nSee: [https://pwwang.github.io/pipen-report][3]\n\n[1]: https://github.com/pwwang/pipen\n[2]: https://pwwang.github.io/pipen-report/example/output/REPORTS\n[3]: https://pwwang.github.io/pipen-report\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Report generation system for pipen",
"version": "0.21.3",
"project_urls": {
"Homepage": "https://github.com/pwwang/pipen-report",
"Repository": "https://github.com/pwwang/pipen-report"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0a9935107c0d5ef92a77faf9a7027524b75c606f33cb14e33a932b7f9b6aa78b",
"md5": "56f171dea78fa9c8d1df28cf69ff0cb8",
"sha256": "cf8f5818fcc76e222c90b8311548efcd42c6dd4314d0fb6e5c85d83a4d3e6ddd"
},
"downloads": -1,
"filename": "pipen_report-0.21.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "56f171dea78fa9c8d1df28cf69ff0cb8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 137752,
"upload_time": "2024-08-18T04:36:26",
"upload_time_iso_8601": "2024-08-18T04:36:26.817266Z",
"url": "https://files.pythonhosted.org/packages/0a/99/35107c0d5ef92a77faf9a7027524b75c606f33cb14e33a932b7f9b6aa78b/pipen_report-0.21.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "30f67e651303170320f0d7334ea6e523bcf43f80cdd433a1ffcc3b0d46b43816",
"md5": "42eec0a701c638a3d25c1d8f635260f7",
"sha256": "1125c853283950ccfd1ccb118b52e0dcd5ac9b5889a869c2efb9fbd16bc19c3a"
},
"downloads": -1,
"filename": "pipen_report-0.21.3.tar.gz",
"has_sig": false,
"md5_digest": "42eec0a701c638a3d25c1d8f635260f7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 123808,
"upload_time": "2024-08-18T04:36:28",
"upload_time_iso_8601": "2024-08-18T04:36:28.557191Z",
"url": "https://files.pythonhosted.org/packages/30/f6/7e651303170320f0d7334ea6e523bcf43f80cdd433a1ffcc3b0d46b43816/pipen_report-0.21.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-18 04:36:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pwwang",
"github_project": "pipen-report",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "pipen-report"
}