Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

upgrade plugin documentation #2695

Open
ctb opened this issue Jul 31, 2023 · 3 comments
Open

upgrade plugin documentation #2695

ctb opened this issue Jul 31, 2023 · 3 comments
Labels
plugin a plugin for sourmash!

Comments

@ctb
Copy link
Contributor

ctb commented Jul 31, 2023

Dev docs: https://sourmash.readthedocs.io/en/latest/dev_plugins.html -

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
@ctb ctb added the plugin a plugin for sourmash! label Jul 31, 2023
@ctb
Copy link
Contributor Author

ctb commented Jul 31, 2023

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.)

@ctb
Copy link
Contributor Author

ctb commented Aug 1, 2023

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.

@ctb
Copy link
Contributor Author

ctb commented Aug 11, 2024

add a checklist for plugin deprecation, too? per #3285

ctb added a commit that referenced this issue Aug 12, 2024
* Fixes #3271 by adding
"versions" to `sourmash info -v` info.
* Starts to tackle #2870

Related issues:
* #2695

---------

Co-authored-by: Luiz Irber <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
plugin a plugin for sourmash!
Projects
None yet
Development

No branches or pull requests

1 participant