https://github.com/ctb/sourmash_plugin_template_test1
testing the plugin template!
https://github.com/ctb/sourmash_plugin_template_test1
Last synced: 12 months ago
JSON representation
testing the plugin template!
- Host: GitHub
- URL: https://github.com/ctb/sourmash_plugin_template_test1
- Owner: ctb
- License: bsd-3-clause
- Created: 2023-01-05T18:34:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-20T03:13:44.000Z (over 3 years ago)
- Last Synced: 2025-03-26T02:42:55.281Z (over 1 year ago)
- Language: Python
- Size: 56.6 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sourmash_plugin_xyz: a template for sourmash plugins
This is a good place to start if you're writing a plugin for
[sourmash (sourmash-bio/sourmash/)](https://github.com/sourmash-bio/sourmash/).
Note: for now, depends on
[sourmash#2428](https://github.com/sourmash-bio/sourmash/pull/2428).
## Instructions
You can use this repo as a template repo to create a new plugin!
First, go to [the GitHub page](https://github.com/sourmash-bio/sourmash_plugin_template) and click "Use this template" to create a new repository.
Clone that repository into your development space.
Then, search for all places where 'xyz' is present, and replace
'xyz' with the name of your plugin.
Next, edit the code in `src/sourmash_plugin_xyz.py` to implement the plugin
(you'll probably want to change the name of that file, too.)
Then run `pip install .` to install and test your plugin! You can also
run `pip install -e .` to install it in editable mode, which is more
convenient for development.
## Examples
[sourmash_plugin_avro](https://github.com/sourmash-bio/sourmash_plugin_avro)
and
[sourmash_plugin_load_urls](https://github.com/sourmash-bio/sourmash_plugin_load_urls)
are two examples you can follow.