-
Notifications
You must be signed in to change notification settings - Fork 38
Add ImJoy demo plugin and badge #20
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
Conversation
| const { setupRPC } = await import('imjoy-rpc'); | ||
| const api = await setupRPC({ name: 'viv-plugin' }); | ||
| const api = await setupRPC({ | ||
| name: 'vizarr', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am changing the name to vizarr here to be consistent with the web app name.
manzt
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wow, thanks for adding this! Just some clarification questions and then I'll get things merged.
| const api = await setupRPC({ | ||
| name: 'vizarr', | ||
| description: 'A minimal, purely client-side program for viewing Zarr-based images with Viv & ImJoy', | ||
| version: vizarrVersion, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As a side note, how do you version kaibu? When hosting the app on gh-pages, I'm not sure of the best way to ensure older versions are available.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We use netlify for that, it can build different sites for releases and PRs (example) as I mentioned in another PR. The setup is very easy, you basically connect the repo and fill in the a build command.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
BTW, could you test and see if you get the version work. For some reason, npm run dev didn't work for me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For some reason, npm run dev didn't work for me.
What isn't working exactly?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If I change the create window src to http://127.0.0.1:3000, it doesn’t work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It works now, just tried it. please ignore this, sorry.
|
Please take a look @manzt |
|
Looks good, but could you also update the plugin name in |
example/imjoy_plugin.py
Outdated
|
|
||
| def run_vizarr(images, view_state=None): | ||
| api.export(Plugin(images, view_state)) | ||
| api.export(Plugin(images, view_state)) No newline at end of file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't leave a comment, but the type needs to be updated above on line 47
|
Done! |
|
Thanks! |
* Add description and version number * improve readability in imjoy_plugin via api.init * bump imjoy-rpc version * recover imjoy_plugin * bump imjoy-rpc version * Fix plugin name * Add ImJoy demo plugin and badge * Simplify vizarr demo * set workspace to vizarr * Fix plugin name * Add readme * rename type
This PR add a imjoy demo plugin which can be installed by click the "launch ImJoy" badge.
It also change the imjoy plugin name to from
viv-plugintovizarr, add other meta information which will show up in the plugin installation dialog in ImJoy.Try with this button:
The demo plugin is taken from the getting started notebook, it would be cool if we can later build an ImJoy plugin for running the image registration workflow.