snakemake / snakemake/snakemake-interface-common

Register plugins through entry points

Open
#80 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
0
Forks
7
Avg merge
31m
Merged PRs (30d)
1

Description

Have you considered making plugins able to be registered through the entry point system?

The plugin author could simply add something like the following to pyproject.toml:

[project.entry-points."snakemake.logger"]
mylogger = "mypackage.pluginmodule:LogHandler"

This would not require the package to have a specific name/structure and would also work with editable installs, making development easier.

I'd be happy to contribute a PR if people think it would be a good feature.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the plugin registration and discovery entry points in the repository, along with the linked pytest entry-point documentation. Confirm how the pyproject.toml example should map plugin names to LogHandler objects and how editable installs should behave. Done means plugins can register through the snakemake.logger entry-point group without requiring a specific package name or structure.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.