search

microsoft / gather

Spit shine for Jupyter notebooks 🧽✨
https://microsoft.github.io/gather
MIT License
532 stars 38 forks source link

binder files #12

Closed choldgraf closed 5 years ago

choldgraf commented 5 years ago

Hey @andrewhead 👋

this PR adds some minimal files that will allow this repository to be built with BinderHub (we run a public BinderHub at mybinder.org). It adds a folder that define two configuration files Binder can use to determine the environment needed to run the repository.

It'll let you share Binder links so that others can interact with the code inside. For example, here's the Binder link to my branch:

https://mybinder.org/v2/gh/choldgraf/gather/binder?urlpath=lab

Try creating a Jupyter Notebook and you should see the Gather interface on there!

If you like this, we should merge another PR that adds a demo notebook people can use to try out Gather!

msftclas commented 5 years ago

CLA assistant check
All CLA requirements met.

andrewhead commented 5 years ago

Hey @choldgraf 👋 !

Love the idea to use BinderHub for a live demo with a pre-made notebook. Great call.

Are there trade-offs between adding Binder files and example notebooks in this repo vs. putting these Binder files in a new repo?

I saw in the Binder FAQs that repo size doesn't affect the launch time. Do you have any thoughts about whether it's kosher to include a bunch of junk in the repo submitted to BinderHub (e.g., all the source and test code BinderHub won't care about?)