nci-ipynb 2023.11.0.3

Simply returns either notebook filename or the full path to the notebook when run from Jupyter notebook in browser.

nci_ipynb

This work was inspired from ipynbname.

When run in a Jupyter notebook, simply returns the notebook filename or the full path to the notebook. I created this to help with automating posting blog posts written in Jupyter notebooks directly to GitHub Pages.

You would think there was already some built-in way to access the current notebook name, but it took many hours of searching for a way to do it. As it seems many others did, I tried using Javascript, but the async nature of JS meant that it was unreliable. Finally I stumbled on this post. I have refactored the code there so a user can get either the name or path, but credit for most of the code goes to the author of this post, thanks!

Examples

Get the notebook name:

import nci_ipynb
nb_fname = nci_ipynb.name()

Get the full path to the notebook:

import nci_ipynb
nb_path = nci_ipynb.path()

Get the root directory to the notebook:

import nci_ipynb
nb_path = nci_ipynb.dir()

Limitations

Note that this only reliably works when running a notebook in a browser. So it does not currently work for things like nbconvert or papermill.

For VS Code there is a workaround.