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

Polus plugins : Fix how plugin names are generated #470

Open
agerardin opened this issue Sep 20, 2023 · 0 comments
Open

Polus plugins : Fix how plugin names are generated #470

agerardin opened this issue Sep 20, 2023 · 0 comments
Labels
bug Something isn't working

Comments

@agerardin
Copy link
Contributor

Summary

polus plugins ingest names from the plugin manifest.
In order to make them valid properties of polus plugins, their names need to be transformed.
However, the manifest returned to the user has no mention of this and this prevents the user to know how to refer to his plugin, except through manual inspection. This is a usability issue.

Possible fixes

We could tackle two different ways.
1/ Enforce certains rules for names in the plugin manifest so that they can be used as properties.
2/ Explicitly add a plugin_id or plugin_handle to to the manifest that is documented and that can be used to refer to the plugin later from polus-plugins
3/ modify all methods so that names are transparently translated if needed.

Steps to reproduce

Example of client code :

        manifest = pp.submit_plugin(plugin_url, refresh=True)
        # name_cleaner is polus_plugins internal code
        plugin_classname = name_cleaner(manifest.name)
        pp.refresh()
        cwl = pp.get_plugin(plugin_classname).save_cwl(cwl_path / f"{plugin_classname}.cwl")
@agerardin agerardin added the bug Something isn't working label Sep 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant