JUPYTER-NBCLASSIC(1)

✨ JUPYTER-NBCLASSIC ✨

okay bestie, gather round, because this is jupyter-nbclassic β€” a User Commands girlie whose whole job is to launch a Tornado based HTML Notebook Server. yes, that notebook. the OG vibe. she's serving classic energy and she's iconic for it πŸ’…


πŸŽ€ OPTIONS πŸŽ€

so here's the tea, bestie: every single option below is just a convenience alias to a configurable class-option β€” you can find which one in the "Equivalent to" line that comes with each alias. wanna see ALL the configurable class-options for some <cmd>? just run this:

<cmd> --help-all

periodt. now let's get into the menu πŸ“

  • --no-browser β€” don't pop the notebook open in a browser once it's up and running. lowkey chill. Equivalent to: [--ServerApp.open_browser=False]
  • --no-mathjax β€” turns MathJax off.

MathJax is the javascript library Jupyter uses to render math/LaTeX. it is very large, so if your internet connection is giving dial-up or you're doing offline notebook time, you might wanna disable it. ngl, valid.

when it's disabled, equations etc. will appear as their untransformed TeX source. raw. unfiltered. 😭

Equivalent to: [--NotebookApp.enable_mathjax=False]

  • --allow-root β€” let the notebook be run from the root user. yes, root. the main character. Equivalent to: [--ServerApp.allow_root=True]
  • --ip=<Unicode> β€” the IP address the Jupyter server will listen on. Default: 'localhost' Equivalent to: [--ServerApp.ip]
  • --port=<Int> β€” the port the server will listen on (env: JUPYTER_PORT). Default: 0 Equivalent to: [--ServerApp.port]
  • --port-retries=<Int> β€” how many extra ports to try if the one you asked for is already taken (env: JUPYTER_PORT_RETRIES). Default: 50 Equivalent to: [--ServerApp.port_retries]
  • --keyfile=<Unicode> β€” the full path to a private key file for usage with SSL/TLS. Default: '' Equivalent to: [--ServerApp.keyfile]
  • --certfile=<Unicode> β€” the full path to an SSL/TLS certificate file. Default: '' Equivalent to: [--ServerApp.certfile]
  • --client-ca=<Unicode> β€” the full path to a certificate authority certificate for SSL/TLS client authentication. Default: '' Equivalent to: [--ServerApp.client_ca]
  • --notebook-dir=<Unicode> β€” DEPRECATED, use root_dir instead. girlie is retired, she's living her soft life now πŸ™ˆ Default: '' Equivalent to: [--ServerApp.notebook_dir]
  • --browser=<Unicode> β€” tell it exactly what command to use to invoke a web browser when starting the server. if you don't specify one, the default browser gets determined by the webbrowser standard library module β€” which means you can set the BROWSER environment variable to override it. iykyk πŸ’–

Default: '' Equivalent to: [--ServerApp.browser]


quick vibe check, bestie: a bunch of these are environment-variable aware (JUPYTER_PORT, JUPYTER_PORT_RETRIES, BROWSER) and a bunch of them are SSL/TLS related, so if you're locking things down, that's your section. also --notebook-dir is DEPRECATED β€” no cap β€” so use root_dir. πŸ’€

and that's the whole page, no skips, no cuts. this was jupyter-nbclassic 6.4.5, dated November 2021, and honestly? she ate. 🫢 go forth and launch your notebook, queen πŸ‘‘πŸŒˆ