How to build a plugin starting from the template repo. #1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ctb
changed the title
ctb
commented
Jan 6, 2023
| readme = "README.md" | ||
| requires-python = ">=3.8" | ||
| version = "0.1" | ||
|
|
||
| dependencies = ["sourmash>=4.8.0,<5"] | ||
| dependencies = ["sourmash>=4.6.1,<5"] |
There was a problem hiding this comment.
This is needed because sourmash v4.8 isn't yet released.
ctb
commented
Jan 6, 2023
|
|
||
| [metadata] | ||
| license = { text = "BSD 3-Clause License" } | ||
|
|
||
| # CTB note: do not need both reader and writer. | ||
|
|
||
| [project.entry-points."sourmash.load_from"] | ||
| xyz_reader = "sourmash_plugin_xyz:load_sketches" | ||
| test1_reader = "sourmash_plugin_test1:load_sketches" |
There was a problem hiding this comment.
the sourmash_plugin_test1 needs to match the project name, above.
ctb
commented
Jan 6, 2023
| @@ -15,10 +15,12 @@ | |||
| # | |||
|
|
|||
| def load_sketches(location, *args, **kwargs): | |||
| if location and location.endswith('.xyz'): | |||
| if location and location.endswith('.test1.sig'): | |||
There was a problem hiding this comment.
this plugin handles loading for all files with extension .test1.sig.
ctb
commented
Jan 6, 2023
| @@ -37,17 +39,20 @@ def __init__(self, location): | |||
| def matches(self, location): | |||
| # match anything that is not None or "" | |||
| if location: | |||
| return location.endswith('.xyz') | |||
| notify(f"*** test1 plugin matches {location}! using!") | |||
| return location.endswith('.test1.sig') | |||
There was a problem hiding this comment.
and this plugin handles saving for all files with extension .test1.sig.
ctb
commented
Jan 9, 2023
src/sourmash_plugin_test1.py
Outdated
| class ScriptsCommand_XYZ: | ||
| command = "xyz" | ||
| description = "do something xyz" | ||
| class ScriptsCommand_Test1: |
There was a problem hiding this comment.
This adds a command-line command sourmash scripts test1 <filename_test> -x/--xyz.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an example of writing a sourmash plugin, starting from sourmash-bio/sourmash_plugin_template.
Look under "Files changed" to see the aggregate changes.
How to install and run
I install this branch with:
and then:
outputs
and
shows:
demonstrating that the plugin is loading and running properly! 馃帀