# Snakemake Logger Plugin - Flowo
A Snakemake logger plugin designed to be used with **[FlowO](https://github.com/zhanghaomiao/flowo)** for real-time task monitoring, making workflow management simple, interactive, and fun! 🎉
**Demo page: [flowo online](https://zhanghaomiao.github.io/flowo)**
## 🎈 Features
- Stores Snakemake workflow execution data in PostgreSQL database
- Tracks jobs, rules, files, and errors
- Provides comprehensive logging and monitoring capabilities
- Easy integration with existing Snakemake workflows
## 💻 Installation
```bash
pip install snakemake-logger-plugin-flowo
```
## 🔧 Configuration
```bash
# To generate the default configuration file, run the following command:
# This will create the default .env configuration file in your $HOME/.config/flowo/ directory.
flowo --generate-config
# After generating the .env file, open it with your preferred text editor to adjust the settings:
vim $HOME/.config/flowo/.env
```
The following environment variables are available for configuration in the `.env` file:
- `POSTGRES_USER`: PostgreSQL username (default: flowo)
- `POSTGRES_PASSWORD`: PostgreSQL password (default: flowo_password)
- `POSTGRES_DB`: PostgreSQL database name (default: flowo_logs)
- `POSTGRES_HOST`: PostgreSQL host (default: localhost)
- `POSTGRES_PORT`: PostgreSQL port (default: localhost: 5432)
- `FLOWO_USER`: User displayed in Flowo
- `FLOWO_WORKING_PATH`: Snakemake execution project path
## 🚀 Usage
Basic usage
```bash
snakemake --logger flowo
```
config `flowo_project_name` or `flowo_tags`
```
snakemake \
--config flowo_project_name=your_project_name flowo_tags="tagA,tagB,tagC" \
--logger flowo
```
or config in --configfile
```
flowo_project_name: your_project_name
flowo_tags: "tagA,tagB,tagC"
```
## 🙏 Acknowledgement
This project is developed based on the excellent work of [cademirch/snakemake-logger-plugin-snkmt](https://github.com/cademirch/snakemake-logger-plugin-snkmt).
Special thanks to the original author for providing a solid foundation under the MIT License.
Raw data
{
"_id": null,
"home_page": null,
"name": "snakemake-logger-plugin-flowo",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "logger, plugin, postgresql, snakemake, workflow",
"author": null,
"author_email": "Haomiao Zhang <zhanghm@iregene.com>, Jingmin Zhang <zhangjm@iregene.com>",
"download_url": "https://files.pythonhosted.org/packages/3e/1a/012a5ace0cc94d50ce5dda18c88dba3a6cd165cbca73d80b555b41afc883/snakemake_logger_plugin_flowo-0.1.8.tar.gz",
"platform": null,
"description": "# Snakemake Logger Plugin - Flowo\n\nA Snakemake logger plugin designed to be used with **[FlowO](https://github.com/zhanghaomiao/flowo)** for real-time task monitoring, making workflow management simple, interactive, and fun! \ud83c\udf89\n\n**Demo page: [flowo online](https://zhanghaomiao.github.io/flowo)**\n\n## \ud83c\udf88 Features\n\n- Stores Snakemake workflow execution data in PostgreSQL database\n- Tracks jobs, rules, files, and errors\n- Provides comprehensive logging and monitoring capabilities\n- Easy integration with existing Snakemake workflows\n\n## \ud83d\udcbb Installation\n\n```bash\npip install snakemake-logger-plugin-flowo\n```\n## \ud83d\udd27 Configuration\n\n```bash\n# To generate the default configuration file, run the following command:\n# This will create the default .env configuration file in your $HOME/.config/flowo/ directory.\nflowo --generate-config\n\n# After generating the .env file, open it with your preferred text editor to adjust the settings:\nvim $HOME/.config/flowo/.env\n```\nThe following environment variables are available for configuration in the `.env` file:\n\n- `POSTGRES_USER`: PostgreSQL username (default: flowo)\n- `POSTGRES_PASSWORD`: PostgreSQL password (default: flowo_password)\n- `POSTGRES_DB`: PostgreSQL database name (default: flowo_logs)\n- `POSTGRES_HOST`: PostgreSQL host (default: localhost)\n- `POSTGRES_PORT`: PostgreSQL port (default: localhost: 5432)\n- `FLOWO_USER`: User displayed in Flowo\n- `FLOWO_WORKING_PATH`: Snakemake execution project path\n\n## \ud83d\ude80 Usage\nBasic usage\n```bash\nsnakemake --logger flowo\n```\nconfig `flowo_project_name` or `flowo_tags`\n```\nsnakemake \\\n --config flowo_project_name=your_project_name flowo_tags=\"tagA,tagB,tagC\" \\\n --logger flowo\n```\nor config in --configfile\n```\nflowo_project_name: your_project_name\nflowo_tags: \"tagA,tagB,tagC\"\n```\n\n## \ud83d\ude4f Acknowledgement\n\nThis project is developed based on the excellent work of [cademirch/snakemake-logger-plugin-snkmt](https://github.com/cademirch/snakemake-logger-plugin-snkmt).\nSpecial thanks to the original author for providing a solid foundation under the MIT License.",
"bugtrack_url": null,
"license": null,
"summary": "A Snakemake logger plugin that stores workflow execution data in PostgreSQL",
"version": "0.1.8",
"project_urls": {
"Homepage": "https://github.com/jmzhang1911/snakemake-logger-plugin-flowo",
"Issues": "https://github.com/jmzhang1911/snakemake-logger-plugin-flowo/issues",
"Repository": "https://github.com/jmzhang1911/snakemake-logger-plugin-flowo"
},
"split_keywords": [
"logger",
" plugin",
" postgresql",
" snakemake",
" workflow"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "04bd93f60a5e33311094fbe883d6f3502dbda5a9349fcaddfb8275d071996036",
"md5": "5b67f5495a73a996bbd885f56f605bb7",
"sha256": "e75fce9788d402bb56de508dd67501d492cb29708f158f3719083200ad3ca51b"
},
"downloads": -1,
"filename": "snakemake_logger_plugin_flowo-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5b67f5495a73a996bbd885f56f605bb7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 18114,
"upload_time": "2025-09-05T03:39:39",
"upload_time_iso_8601": "2025-09-05T03:39:39.003698Z",
"url": "https://files.pythonhosted.org/packages/04/bd/93f60a5e33311094fbe883d6f3502dbda5a9349fcaddfb8275d071996036/snakemake_logger_plugin_flowo-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3e1a012a5ace0cc94d50ce5dda18c88dba3a6cd165cbca73d80b555b41afc883",
"md5": "9e4e130a6b3976ac79deb695640fbcf3",
"sha256": "6e24a189314ad719dd04e510d08add2b184b491882edf6fef3d64f8a4411a5ef"
},
"downloads": -1,
"filename": "snakemake_logger_plugin_flowo-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "9e4e130a6b3976ac79deb695640fbcf3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 52653,
"upload_time": "2025-09-05T03:39:39",
"upload_time_iso_8601": "2025-09-05T03:39:39.786886Z",
"url": "https://files.pythonhosted.org/packages/3e/1a/012a5ace0cc94d50ce5dda18c88dba3a6cd165cbca73d80b555b41afc883/snakemake_logger_plugin_flowo-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-05 03:39:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jmzhang1911",
"github_project": "snakemake-logger-plugin-flowo",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "snakemake-logger-plugin-flowo"
}
JSON
