|
1 | 1 | # Snakemake Logger Plugin - Flowo |
2 | 2 |
|
3 | | -A Snakemake logger plugin that stores workflow execution data in PostgreSQL. |
| 3 | +A Snakemake logger plugin that stores workflow execution data in PostgreSQL, making your workflow management more efficient and fun! 🎉 |
4 | 4 |
|
5 | | -## Features |
| 5 | +## 🎈 Features |
6 | 6 |
|
7 | | -- Stores Snakemake workflow execution data in PostgreSQL database |
8 | | -- Tracks jobs, rules, files, and errors |
9 | | -- Provides comprehensive logging and monitoring capabilities |
10 | | -- Easy integration with existing Snakemake workflows |
| 7 | +- Stores Snakemake workflow execution data in PostgreSQL database 🚀 |
| 8 | +- Tracks jobs, rules, files, and errors 🔍 |
| 9 | +- Provides comprehensive logging and monitoring capabilities 🚨 |
| 10 | +- Easy integration with existing Snakemake workflows 🔄 |
11 | 11 |
|
12 | | -## Installation |
| 12 | +## 💻 Installation |
13 | 13 |
|
14 | 14 | ```bash |
15 | 15 | pip install snakemake-logger-plugin-flowo |
16 | 16 | ``` |
17 | | - |
18 | | -## Usage |
19 | | - |
20 | | -### 1. Configure Database |
21 | | - |
22 | | -Set up your PostgreSQL database and configure the connection: |
| 17 | +## 🔧 Configuration |
23 | 18 |
|
24 | 19 | ```bash |
25 | | -export POSTGRES_USER=snakemake |
26 | | -export POSTGRES_PASSWORD=snakemake_password |
27 | | -export POSTGRES_DB=snakemake_logs |
28 | | -``` |
| 20 | +# To generate the default configuration file, run the following command: |
| 21 | +# This will create the default .env configuration file in your $HOME/.config/flowo/ directory. |
| 22 | +flowo --generate-config |
29 | 23 |
|
30 | | -### 2. Use with Snakemake |
31 | | - |
32 | | -Run your Snakemake workflow with the logger plugin: |
33 | | - |
34 | | -```bash |
35 | | -snakemake --logger flowo |
| 24 | +# After generating the .env file, open it with your preferred text editor to adjust the settings: |
| 25 | +vim $HOME/.config/flowo/.env |
36 | 26 | ``` |
| 27 | +The following environment variables are available for configuration in the `.env` file: |
37 | 28 |
|
38 | | -## Configuration |
| 29 | +- `POSTGRES_USER`: PostgreSQL username (default: flowo) |
| 30 | +- `POSTGRES_PASSWORD`: PostgreSQL password (default: flowo_password) |
| 31 | +- `POSTGRES_DB`: PostgreSQL database name (default: flowo_logs) |
| 32 | +- `POSTGRES_HOST`: PostgreSQL host (default: localhost) |
| 33 | +- `POSTGRES_PORT`: PostgreSQL port (default: localhost: 5432) |
| 34 | +- `FLOWO_USER`: |
| 35 | +- `FLOWO_WORKING_PATH`: |
39 | 36 |
|
40 | | -The plugin can be configured using environment variables: |
41 | | - |
42 | | -- `POSTGRES_USER`: PostgreSQL username (default: snakemake) |
43 | | -- `POSTGRES_PASSWORD`: PostgreSQL password (default: snakemake_password) |
44 | | -- `POSTGRES_DB`: PostgreSQL database name (default: snakemake_logs) |
45 | | -- `SQL_ECHO`: Enable SQL query logging (default: False) |
46 | | - |
47 | | -## Development |
48 | | - |
49 | | -### Setup |
| 37 | +## 🚀 Usage |
50 | 38 |
|
51 | 39 | ```bash |
52 | | -git clone <repository-url> |
53 | | -cd snakemake-logger-plugin-flowo |
54 | | -uv sync |
| 40 | +snakemake --logger flowo |
55 | 41 | ``` |
56 | 42 |
|
57 | | -### Build |
58 | | - |
59 | | -```bash |
60 | | -uv build |
61 | | -``` |
62 | 43 |
|
63 | | -## License |
| 44 | +## 📜 License |
64 | 45 |
|
65 | 46 | MIT License |
0 commit comments