Metadata-Version: 2.3
Name: pipen-log2file
Version: 0.9.0a2
Summary: Add verbosal information in logs 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
Requires-Dist: pipen (>=0.16.0a1,<0.17.0)
Project-URL: Homepage, https://github.com/pwwang/pipen-log2file
Project-URL: Repository, https://github.com/pwwang/pipen-log2file
Description-Content-Type: text/markdown

# pipen-log2file

Save running logs to file for [pipen][1].

The log file is saved to `<workdir>/<pipeline>/.logs/run-<date-time>.log` by default.
A symlink `<workdir>/<pipeline>/run-latest.log` is created to the latest log file.

The xqute logs are also saved to `<workdir>/<pipeline>/<proc>/proc.xqute.log`

Note that the original handler of xqute logger is removed during pipeline running.

## Options

- `plugin_opts.log2file_xqute`: Whether to save xqute logs. Default: `True`.
    if False, the xqute logger will be kept intact.
- `plugin_opts.log2file_xqute_level`: The log level for xqute logger. Default: `INFO`.
- `plugin_opts.log2file_xqute_append`: Whether to append to the log file. Default: `False`.

## Installation

```
pip install -U pipen-log2file
```

## Enabling/Disabling the plugin

The plugin is registered via entrypoints. It's by default enabled. To disable it:
`plugins=[..., "no:log2file"]`, or uninstall this plugin.


[1]: https://github.com/pwwang/pipen

