# 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/b3/6c/e0acfa6e98ffe7db6ce9aec26fe85b27277deea9e3eb48cf7fb5ec976a51/pipen_log2file-0.8.0.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.8.0",
"project_urls": {
"Homepage": "https://github.com/pwwang/pipen-log2file",
"Repository": "https://github.com/pwwang/pipen-log2file"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f57121a75d2b66764a19726ba1af5a4b54fa464069de97db4c421115e4e4210e",
"md5": "2a6f2053d4a726c72df62bef774b23de",
"sha256": "c38a33e21585bd378e27d033da83e1153a3672305902e26cc533328e607e1b15"
},
"downloads": -1,
"filename": "pipen_log2file-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2a6f2053d4a726c72df62bef774b23de",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 4545,
"upload_time": "2024-07-23T22:51:38",
"upload_time_iso_8601": "2024-07-23T22:51:38.875203Z",
"url": "https://files.pythonhosted.org/packages/f5/71/21a75d2b66764a19726ba1af5a4b54fa464069de97db4c421115e4e4210e/pipen_log2file-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b36ce0acfa6e98ffe7db6ce9aec26fe85b27277deea9e3eb48cf7fb5ec976a51",
"md5": "08b3482edff7929ac0b74b233350825b",
"sha256": "043c76e2c176140f7ed6e6f82a76ddb1df14b218f190c668ac4373c46a105c97"
},
"downloads": -1,
"filename": "pipen_log2file-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "08b3482edff7929ac0b74b233350825b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 4290,
"upload_time": "2024-07-23T22:51:40",
"upload_time_iso_8601": "2024-07-23T22:51:40.103882Z",
"url": "https://files.pythonhosted.org/packages/b3/6c/e0acfa6e98ffe7db6ce9aec26fe85b27277deea9e3eb48cf7fb5ec976a51/pipen_log2file-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-23 22:51:40",
"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
