joouha / euporie

Jupyter notebooks in the terminal
https://euporie.readthedocs.io
MIT License
1.54k stars 36 forks source link

Update Install docs to note that gcc-11 may need to be installed #45

Closed jessebot closed 1 year ago

jessebot commented 1 year ago

without this, if you try to pip install or pipx install on Debian Bookworm, it will fail to build the pre-reqs.

joouha commented 1 year ago

Hi,

I've been having a think about where best to put this in the documentation.

Because GCC isn't a true dependency of euporie, but an (occasional) build dependency of other packages (https://github.com/joouha/euporie/issues/44#issuecomment-1333544316), I think it makes sense to add a note before the Try without installing heading.

Something like this?


.. note::
   Although euporie itself is written in pure Python and does not have any compiled components, some of its dependencies may require compilation as part of their build steps, depending on the availability of binary wheels. 

   If this is the case, you may need to install the relevant build tools for your distribution, such as `python-dev` and `gcc` or equivalent.

What do you think?

jessebot commented 1 year ago

Thanks for the quick response, and sorry for the delay :)

I added a new commit. I agree with it being a note and your more descriptive sentences, but I think it should be before the actual installation, to prevent the user getting an error in the first place.

I do feel like the note is visually kinda large though, and so the instinct is to put it after the install, so that the install process doesn't look daunting and has that "just works" look about it, so I see the merit in putting it after the install process, but the user experience has the potential to be worse, so I feel like the style matters slightly less? My experience may also just be a weird edge case. 🤷

joouha commented 1 year ago

Thanks for your comments - it's really useful to hear about your user experience.

All of euporie's dependencies with compiled components now have binary wheels on PyPI, so it's now possible to install euporie on Python 3.11 without the need for GCC.

I'm going to keep the note at the end of the installation section for now. If this issue proves to be more of a problem for users I'll move move things around a bit.

Thanks for your help with this!

joouha commented 1 year ago

(I've rebased this and merged it onto the dev branch. Github doesn't seem to have like the way I did it, but it has been merged)

jessebot commented 1 year ago

Thank you!