jupyter-book/thebe

Use `@jupyterhub/binderhub-client` to talk to the binderhub API

Opened this issue · 4 comments

(big fan of Thebe)

Hello!

I've spent time in the last few months cleaning up the API code that the binderhub frontend uses to talk to the binderhu backend, and it's called @jupyterhub/binderhub-client (https://github.com/jupyterhub/binderhub/tree/main/js/packages/binderhub-client). It's up on npm (although pending a new release). It is much cleaner than what came before, has unit tests, and has a fairly clean JS interface (async iterator!).

I'd love for thebe to replace its own API client talking to binderhub with a dependency on this. It'll also help me see what features are missing for external use, and we can add that too.

/cc @minrk who was open to the idea

(shout out to GESIS in cooperation with NFDI4DS 460234259 and CESSDA.)

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

@yuvipanda thanks for the pointer -- this would be a much better way to be talking to the hub. I've got some time planned over the next couple of weeks to make some steps with thebe (docs & release!!) and can get into this as part of that.

Great to hear, @stevejpurves! I just published latest version on npmjs as well :)

While there is no generated JSDoc page yet, I have written some amount of docs at https://github.com/jupyterhub/binderhub/blob/main/js/packages/binderhub-client/lib/index.js. I hope that is helpful.

Linking also to jupyterhub/binderhub#1836 which is a proposal to move in this direction.