search

jupyter-widgets / widget-cookiecutter

A cookiecutter template for creating a custom Jupyter widget project.
BSD 3-Clause "New" or "Revised" License
258 stars 72 forks source link

Explain naming scheme #66

Open ianhi opened 4 years ago

ianhi commented 4 years ago

Same as https://github.com/jupyter-widgets/widget-ts-cookiecutter/issues/76 to keep info in both cookiecutters the same

My understanding of the the widget naming convention is that the names are like so: Python: ipy<something> typescript: jupyter-<something>

With the idea being that the typescript part will be kernel-langauge agnostic and so shouldn't have an ipy in the name. i.e. if someone wanted make a cpp version of the widget they would only have to write cpp<something> they could then hook up to jupyter-<something> without ever having to write any typescript.

Conditional on the above being a correct assessment maybe this should be added to the top level readme of this repo?

Or in a more extreme move the cookiecutter could be changed to hint at this convention.

martinRenou commented 4 years ago

With the idea being that the typescript part will be kernel-langauge agnostic and so shouldn't have an ipy in the name. i.e. if someone wanted make a cpp version of the widget they would only have to write cpp they could then hook up to jupyter- without ever having to write any typescript.

:+1: That's the idea indeed.