# 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
Raw data
{
"_id": null,
"home_page": "https://github.com/pwwang/pipen-log2file",
"name": "pipen-log2file",
"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/3c/18f647d98a0878f7b87f9c846b37add7cd9ac6f18f90d8b4d46c6f8eaa91/pipen_log2file-0.10.1.tar.gz",
"platform": null,
"description": "# pipen-log2file\n\nSave running logs to file for [pipen][1].\n\nThe log file is saved to `<workdir>/<pipeline>/.logs/run-<date-time>.log` by default.\nA symlink `<workdir>/<pipeline>/run-latest.log` is created to the latest log file.\n\nThe xqute logs are also saved to `<workdir>/<pipeline>/<proc>/proc.xqute.log`\n\nNote that the original handler of xqute logger is removed during pipeline running.\n\n## Options\n\n- `plugin_opts.log2file_xqute`: Whether to save xqute logs. Default: `True`.\n if False, the xqute logger will be kept intact.\n- `plugin_opts.log2file_xqute_level`: The log level for xqute logger. Default: `INFO`.\n- `plugin_opts.log2file_xqute_append`: Whether to append to the log file. Default: `False`.\n\n## Installation\n\n```\npip install -U pipen-log2file\n```\n\n## Enabling/Disabling the plugin\n\nThe plugin is registered via entrypoints. It's by default enabled. To disable it:\n`plugins=[..., \"no:log2file\"]`, or uninstall this plugin.\n\n\n[1]: https://github.com/pwwang/pipen\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Add verbosal information in logs for pipen.",
"version": "0.10.1",
"project_urls": {
"Homepage": "https://github.com/pwwang/pipen-log2file",
"Repository": "https://github.com/pwwang/pipen-log2file"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3247be765c0495ae6ea917ac29fba040fa7d4e10968ca0547b23075e92759e6e",
"md5": "17ce6f859f961ba41312626cd4a24490",
"sha256": "08527bc98b352631aa6c9cda1874e9de660dbceb17c78cac73ae1960faec60fe"
},
"downloads": -1,
"filename": "pipen_log2file-0.10.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "17ce6f859f961ba41312626cd4a24490",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 5119,
"upload_time": "2025-08-14T17:50:07",
"upload_time_iso_8601": "2025-08-14T17:50:07.808082Z",
"url": "https://files.pythonhosted.org/packages/32/47/be765c0495ae6ea917ac29fba040fa7d4e10968ca0547b23075e92759e6e/pipen_log2file-0.10.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "303c18f647d98a0878f7b87f9c846b37add7cd9ac6f18f90d8b4d46c6f8eaa91",
"md5": "3d90ea71b65bc89ef620374051a6f699",
"sha256": "c965493ff23a99177e23bcaa07fdab9637973ea5ef65bdc9f57d8cf664684485"
},
"downloads": -1,
"filename": "pipen_log2file-0.10.1.tar.gz",
"has_sig": false,
"md5_digest": "3d90ea71b65bc89ef620374051a6f699",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 4779,
"upload_time": "2025-08-14T17:50:08",
"upload_time_iso_8601": "2025-08-14T17:50:08.935728Z",
"url": "https://files.pythonhosted.org/packages/30/3c/18f647d98a0878f7b87f9c846b37add7cd9ac6f18f90d8b4d46c6f8eaa91/pipen_log2file-0.10.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-14 17:50:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pwwang",
"github_project": "pipen-log2file",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pipen-log2file"
}
JSON
