snakemake-interface-report-plugins

What it is and what it does

This package is a plugin interface definition for Snakemake's report generation system. It provides the base classes and settings framework that third-party report plugins must inherit from to work with Snakemake. Developers building custom report plugins use this package to understand and implement the required contract: a ReporterBase class with a render() method and optional ReportSettingsBase subclass for CLI parameters.

The package is a thin structural layer—it defines what a compliant plugin looks like but does not generate reports itself. It depends only on snakemake-interface-common and is designed to be imported by plugin authors during development. It supports Python 3.11 through 3.14 and is actively maintained.

Use it for:

• Build a custom Snakemake report plugin that generates reports in a proprietary or domain-specific format.
• Extend Snakemake's reporting with integrations to external services (e.g., cloud storage, notification systems).
• Create a report plugin that renders workflow results in a specialized markup or visualization format.
• Scaffold a new report plugin project using the interface as a reference implementation.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Defines the interface contract that Snakemake report plugins must implement to integrate with Snakemake's reporting system.

Yes, if you are developing a Snakemake report plugin. This is a required dependency for plugin authors and provides the interface contract needed to integrate with Snakemake's plugin system. No security vulnerabilities are known. Install it only as a development dependency when building plugins; end users of Snakemake do not need it directly.

Install

snakemake-interface-report-plugins on PyPI

pip install snakemake-interface-report-plugins

uv add snakemake-interface-report-plugins

poetry add snakemake-interface-report-plugins

Installing snakemake-interface-report-plugins

Before you install

Low friction installation with a single runtime dependency on snakemake-interface-common. Actively maintained as of the latest release.

Quickstart

pip install snakemake-interface-report-plugins

from snakemake_interface_report_plugins.reporter import ReporterBase
from snakemake_interface_report_plugins.settings import ReportSettingsBase

class Reporter(ReporterBase):
    def render(self):
        pass

Requires Python 3.11 or later.

Verify before relying

• Whether the package includes automated testing scaffolding or if Snakedeploy is required separately for that.
• Whether documentation exists beyond the interface skeleton shown in the description.

Package facts

Evidence: snakemake_interface_report_plugins-2.0.1-py3-none-any.whl

Tags

More Application Frameworks packages