Jupyter-book: pip installation: jupyter-book or jupyter_book?

[mwcraig]

The documentation mention two ways of installing this package with pip.

jupyter_book: https://github.com/jupyter/jupyter-book/commit/f8a02a2d2e9960be9b481ee3983c1ad237e62830#diff-8bc3bf5fb446a25f20334e287bdfd67dR40

jupyter-book: https://github.com/jupyter/jupyter-book/commit/f8a02a2d2e9960be9b481ee3983c1ad237e62830#diff-8bc3bf5fb446a25f20334e287bdfd67dR40

On pypi there two distributions for this package, one called jupyter_book and the other called jupyter-book: https://pypi.org/project/jupyter-book/#files

Am wondering which of the two is the plan™️ for the future...

[choldgraf]

I think that on pip, it should be jupyter_book, while PyPI actually redirects both to the same page (jupyter-book). This has been a constant source of confusion to me as well :-)

Could you re-check the link for your one of your diffs, they're both the same link! I agree w/ you that we should be consistent in the docs!

[choldgraf]

oh, and my 2 cents on the name is that I prefer jupyter-book, but I don't believe you can pip-install something-something, it needs to be something_something. I would be happy to be wrong on that though :-)

[mwcraig]

Sorry about the link, it should have been: https://github.com/jupyter/jupyter-book/commit/273f14128f62df8adedba080f995dfb8fdd82e3c#diff-0994f3b38c8f068b9d7412d21a5b3444R27

It looks either pip install jupyter-book or pip install jupyter_book work.

The only restriction that I know of related to dashes and package names is that you can't import a name with a dash because it is interpreted as a minus sign. So the tradition is that if you pip install jupyter-book you would import jupyter_book.

I think a - is fine though...

[choldgraf]

looping back in on this,

• good catch about the difference between what you can pip-install vs. what you can import in python
• my preference is for the PyPI version to be jupyter-book (so pip install jupyter-book). Do others agree?
• Either way, do we need to take any action other than making sure the documentation is streamlined? E.g., we don't need to _remove_ the jupyter_book URL since it redirects to jupyter-book (on pypi) anyway, right?

[choldgraf]

the latest version now has jupyter-book only in the documentation, think that's enough for now? thanks for catching this.

[mwcraig]

yep, closing!