snakemake-interface-executor-plugins

What it is and what it does

This package defines the contract between Snakemake and its executor plugins—the classes, methods, and settings that a plugin must implement to integrate a new execution backend (cluster, cloud, container orchestrator, etc.). It is not a standalone tool but a framework for plugin developers.

When building an executor plugin, developers inherit from RemoteExecutor and implement job submission, status checking, and cancellation methods. The package provides base classes, data structures (like SubmittedJobInfo), and settings management to ensure plugins work reliably with Snakemake's core. It depends on argparse-dataclass for CLI argument handling, snakemake-interface-common for shared types, and throttler for rate-limiting remote queries.

Use it for:

• Develop a custom executor plugin to run Snakemake workflows on a proprietary cluster or cloud platform.
• Create a wrapper executor that integrates Snakemake with container orchestration systems like Kubernetes or Docker Swarm.
• Build an executor plugin for specialized hardware (GPU clusters, HPC systems) with custom job scheduling logic.
• Scaffold a new executor plugin using the provided base classes and common settings to ensure Snakemake compatibility.

Worth the install?

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

Provides a stable interface specification for building Snakemake executor plugins that manage job submission and monitoring across different execution backends.

Yes, if you are developing a Snakemake executor plugin. No, if you are a Snakemake end user—install Snakemake itself and the executor plugins you need. This package is a developer dependency, not a user-facing tool. It is actively maintained, has no known vulnerabilities, and uses a permissive license.

Install

snakemake-interface-executor-plugins on PyPI

pip install snakemake-interface-executor-plugins

uv add snakemake-interface-executor-plugins

poetry add snakemake-interface-executor-plugins

Installing snakemake-interface-executor-plugins

Before you install

Low install friction with a pure-Python wheel and minimal dependencies. Actively maintained with recent releases.

License in practice

MIT license permits free use, modification, and distribution with minimal restrictions—suitable for both open-source and commercial projects.

Quickstart

pip install snakemake-interface-executor-plugins

from snakemake_interface_executor_plugins.executors.remote import RemoteExecutor
from snakemake_interface_executor_plugins.settings import ExecutorSettingsBase, CommonSettings

class MyExecutor(RemoteExecutor):
    def __post_init__(self):
        pass

Requires Python 3.11 or later; intended for plugin developers, not end users of Snakemake workflows.

Verify before relying

• Whether this package is intended for direct use by workflow authors or only for plugin developers
• Stability guarantees across Snakemake major versions and how version constraints should be specified

Package facts

Evidence: snakemake_interface_executor_plugins-9.4.0-py3-none-any.whl

Tags

More Application Frameworks packages