sourmash
sourmash copied to clipboard
upgrade plugin documentation
trafficstars
Dev docs: https://sourmash.readthedocs.io/en/latest/dev_plugins.html -
- suggest adding plugins to https://github.com/ctb/sourmash-mixers
- suggest plugins be added whenever new dependencies would be needed
CLI docs: https://sourmash.readthedocs.io/en/latest/command-line.html#using-sourmash-plugins -
- link to sourmash-mixers together with a few examples of super cool things you can do?
- revise text etc etc
also:
- provide suggestions for documentation & metadata for authors:
- provide guidance on how to test your CLI plugin at the CLI (minimal testing regime: sourmash scripts, look for description etc.)
sourmash-mixers is now live on pypi: https://pypi.org/project/sourmash-mixers/0.2/ 🎉
There's a nice issue template on that repo that helps guide new plug-in development, too.
add a checklist for plugin deprecation, too? per https://github.com/sourmash-bio/sourmash/issues/3285