Snakemake logger plugin: snkmt

https://img.shields.io/badge/repository-github-blue?color=%23022c22 https://img.shields.io/badge/author-Cade%20Mirchandani%20%3Ccmirchan%40ucsc.edu%3E-purple?color=%23064e3b PyPI - Version PyPI - License

Warning

This plugin is not maintained and reviewed by the official Snakemake organization.

This is the logging plugin for use with snkmt, a monitoring tool for Snakemake workflows. Please refer to snkmt’s documentation for more details.

This plugin is still under development and thus may not be fully stable or feature-complete. Use it at your own discretion and report any issues or suggestions to the repository’s issue tracker.

Installation

Install this plugin by installing it with pip or mamba, e.g.:

pip install snakemake-logger-plugin-snkmt

Usage

In order to use the plugin, run Snakemake (>=9.0) with the corresponding value for the logger flag:

snakemake --logger snkmt ...

with ... being any additional arguments you want to use.

Settings

The logger plugin has the following settings (which can be passed via command line, the workflow or environment variables, if provided in the respective columns):

Settings

CLI argument

Description

Default

Choices

Required

Type

--logger-snkmt-db VALUE

Set absolute path for database file.

None