Skip to content
New issue

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

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

Already on GitHub? # to your account

Move bio-rdf-validator.imjoy.html to a dedicated folder and add manifest.imjoy.json to root, for plugin discovery #550

Open
jmetz opened this issue Feb 14, 2024 · 4 comments

Comments

@jmetz
Copy link

jmetz commented Feb 14, 2024

Propose a dedicated imjoy-plugins (or similar) folder

@oeway : Is there any standard for this that you would like to encourage for users? Perhaps the above - for a more standardized to allow users / third-parties to register their plugins perhaps.

I'm thinking that eventually / additionally this could become system whereby someone can load plugins in imjoy using just a user/repo syntax, which would then search for a specific folder (eg imjoy-plugins under that github path, and then try and load a file called e.g. imjoy-plugins.json or similar.

Apologies in advance if you already have this @oeway - in which case this issue can be edited to reflect suggesting that we switch to that.

@oeway
Copy link
Contributor

oeway commented Feb 14, 2024

Hi, maybe see here: https://imjoy.io/docs/#/development?id=hosting-and-deploying-plugins

@jmetz
Copy link
Author

jmetz commented Feb 14, 2024

Great - thanks @oeway - in that case I'll update the issue to reflect that suggestion.

(@oeway - Also off-topic, but perhaps it could be cool given you have this "manifest in root of github" recommendation to have a simplified version of https://imjoy.io/docs/#/api?id=apiloadplugin ie api.loadPlugin (or possibly add api.loadPlugins) that accepts eg: {github:"bioimage-io/spec-bioimage-io"} and then reads the manifest in that repo and returns all plugins there. Will make sure that's not already available, and then create corresponding issue)

@jmetz jmetz changed the title Move bio-rdf-validator.imjoy.html to a different forder than scripts Move bio-rdf-validator.imjoy.html to a dedicated folder and add manifest.imjoy.json to root, for plugin discovery Feb 14, 2024
@oeway
Copy link
Contributor

oeway commented Feb 14, 2024

Great - thanks @oeway - in that case I'll update the issue to reflect that suggestion.

(@oeway - Also off-topic, but perhaps it could be cool given you have this "manifest in root of github" recommendation to have a simplified version of https://imjoy.io/docs/#/api?id=apiloadplugin ie api.loadPlugin (or possibly add api.loadPlugins) that accepts eg: {github:"bioimage-io/spec-bioimage-io"} and then reads the manifest in that repo and returns all plugins there. Will make sure that's not already available, and then create corresponding issue)

You mean like this: https://imjoy.io/docs/#/development?id=generating-a-plugin-url-for-sharing
We already supported that, I think:

If your plugins are deployed in a ImJoy Plugin Repository (as described above), you can then use a short plugin URI formatted as GITHUB_USER_NAME/REPO_NAME:PLUGIN_NAME.

For example, you can use imjoy-team/imjoy-project-template:Untitled Plugin to represent a plugin hosted on https://github.com/oeway/DRFNS-Lite.

You can also specify the plugin tag by adding @tag after the PLUGIN_NAME. For example: oeway/DRFNS-Lite:DRFNS-Lite@GPU.

In case you want to specify a git commit hashtag to freeze the plugin at a certain commit, you can add @COMMIT_HASHTAG after the REPO_NAME. For example: oeway/DRFNS-Lite@4063b24:DRFNS-Lite where 4063b24 is the short form of the commit of 4063b24f01eab459718ba87678dd5c5db1e1eda1.

@jmetz
Copy link
Author

jmetz commented Feb 14, 2024

Ahh - yes, sorry again, that's exactly what I was looking for. I'll update the Imjoy issue I created to be more specific and remove that aspect.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants