SimonBiggs / scriptedforms

Quickly create live-update GUIs for Python packages using Markdown and simple HTML elements.
Apache License 2.0
509 stars 34 forks source link

Remove rest API for now #138

Closed SimonBiggs closed 6 years ago

SimonBiggs commented 6 years ago

@robmarkcole does the filechange section cover the cases you were planning on using the rest API for?

If you can feasibly use features of ScriptedForms directly instead of the API I would prefer that. By having the API sit there when it is not currently being used, it is locking something in that might not be optimal.

My preference, remove the API, keep a record of how it was created bring it back at the moment when it is going to be heavily used. That way it can undergo changes at the time when people who are feeding back into the design of it are heavily using it. My primary preference is I would prefer to write the API when I am personally needing it, because then I will know what I need when I am trying to use it.

If we leave it as is, people will start using it, possibly not give feedback on pain points, and then I can't change it because it has been within the code base for a long time.

SimonBiggs commented 6 years ago

Also, until then, if you really need an API, jupyterlab already provides one... In fact, my API actually is just shortcuts to the current Jupyter API...

robmarkcole commented 6 years ago

OK if it is duplicating functionality then we should leave out until expressly required

SimonBiggs commented 6 years ago

Thanks @robmarkcole , the way I see it, all features of the current API can be replaced with the filechange section.

robmarkcole commented 6 years ago

Yes I've lost that issue, which number was it?

SimonBiggs commented 6 years ago

Sorry which issue?

SimonBiggs commented 6 years ago

I'll close the issue once I've actually done it :)

robmarkcole commented 6 years ago

The filewatcher instructions - FOUND IT

SimonBiggs commented 6 years ago

2 :)