Metadata-Version: 2.4
Name: pipen-report
Version: 1.2.1
Summary: Report generation system for pipen
License: MIT
Author: pwwang
Author-email: pwwang@pwwang.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Provides-Extra: runinfo
Requires-Dist: Markdown (>=3,<4)
Requires-Dist: copier (>=9.5) ; python_version >= "3.10"
Requires-Dist: copier (>=9.5,<9.11) ; python_version < "3.10"
Requires-Dist: imagesize (>=1.4,<2.0)
Requires-Dist: pipen (==1.1.*)
Requires-Dist: pipen-runinfo (>=1.1,<2.0) ; extra == "runinfo"
Requires-Dist: python-slugify (>=8.0,<9.0)
Project-URL: Homepage, https://github.com/pwwang/pipen-report
Project-URL: Repository, https://github.com/pwwang/pipen-report
Description-Content-Type: text/markdown

<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

