Skip to main content

A Snakemake logger plugin that stores workflow execution data in PostgreSQL

Project description

Snakemake Logger Plugin - Flowo

A Snakemake logger plugin that stores workflow execution data in PostgreSQL.

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

pip install snakemake-logger-plugin-flowo

Usage

1. Configure Database

Set up your PostgreSQL database and configure the connection:

export POSTGRES_USER=snakemake
export POSTGRES_PASSWORD=snakemake_password
export POSTGRES_DB=snakemake_logs

2. Use with Snakemake

Run your Snakemake workflow with the logger plugin:

snakemake --logger flowo

Configuration

The plugin can be configured using environment variables:

  • POSTGRES_USER: PostgreSQL username (default: snakemake)
  • POSTGRES_PASSWORD: PostgreSQL password (default: snakemake_password)
  • POSTGRES_DB: PostgreSQL database name (default: snakemake_logs)
  • SQL_ECHO: Enable SQL query logging (default: False)

Development

Setup

git clone <repository-url>
cd snakemake-logger-plugin-flowo
uv sync

Build

uv build

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

snakemake_logger_plugin_flowo-0.1.1.tar.gz (50.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

snakemake_logger_plugin_flowo-0.1.1-py3-none-any.whl (16.7 kB view details)

Uploaded Python 3

File details

Details for the file snakemake_logger_plugin_flowo-0.1.1.tar.gz.

File metadata

File hashes

Hashes for snakemake_logger_plugin_flowo-0.1.1.tar.gz
Algorithm Hash digest
SHA256 f37a0c3a09a60354c98bbccb39f0865738e96b7452bcacb16025bd79e9af74d7
MD5 31bfd24f41fa1fd876fc39ded689b7c3
BLAKE2b-256 18c327dff99e6ca2f587d11e79c5fcda62cce204bc0d2b8d60ef0d50f39c1a8b

See more details on using hashes here.

File details

Details for the file snakemake_logger_plugin_flowo-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for snakemake_logger_plugin_flowo-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fa7a9321b35723ac98254096b2f9101706548140e578c040059df5665e335c1f
MD5 903829f8f7277501ba841193ba3b0716
BLAKE2b-256 84acfd3b0e50b5c5f4807df7d5e535b13f8dce3c623296fd47cc55b9475627b7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page