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.0.tar.gz (50.4 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.0-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for snakemake_logger_plugin_flowo-0.1.0.tar.gz
Algorithm Hash digest
SHA256 61c9864cc03904cff64313531539b47a021c7d008752341f25125145be2f9904
MD5 5cdc936ad016580f35d9ce5c743b4d1c
BLAKE2b-256 6deeeee0ab88f600c1dbb7638d279fa841d2a29f8e0e1a8ee817361081205a34

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for snakemake_logger_plugin_flowo-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 49006859ba7312c3eb6f782ee5882a69ffd05a50a1f984d538972df0a96a7f57
MD5 02f1b127f0b9cb9e1adc6f0fd182e678
BLAKE2b-256 2bcb96ca4465eee17043ae347fc4b5b8c6550e7b95d297e4e9e10db23273ea62

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