Skip to main content

Run the Jupyter notebook server as a little app in the system tray

Project description

Jupyter Tray App

Run the Jupyter notebook server as a little app in the system tray.

That way you don't have to keep a separate command window open just for the server.

This app is made for Windows.

It should be portable to Mac/Linux with only minor modifications to the source code and the below usage instructions, as:

  1. The tray icon is made with the cross-platform 'Qt' GUI framework.
  1. The source code is quite simple, and hence easy to modify.

Installation

Make sure PyQt5 is installed:

conda install pyqt

Then run:

pip install jupytray

This will get you the latest version on PyPI

Usage

Bring up the run.exe command launcher, and run:

pythonw -m jupytray

(Note the extra w after python. It stands for "windowless").

This should start the tray app and the notebook server.

Auto-run at boot

To have the tray server start automatically at system boot:

  1. Find your windowless Python executable:
    • Type pythonw.exe in the start menu and choose "Open File Location".
  2. Open your Startup folder:
    • Open run.exe and run shell:startup.
  3. Make a shortcut to your pythonw.exe in this Startup folder.
  4. In the shortcut's Properties, in the "Target" field, append -m jupytray
    • So the total Target will read e.g. C:\conda\pythonw.exe -m jupytray
  5. In the "Start in" field, type the path you want the notebook server's root to be.
  6. Rename your shortcut to something like "Start Jupyter tray app"

The tray app and notebook server will now auto-run after system restarts.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupytray-0.3.tar.gz (8.0 kB view hashes)

Uploaded Source

Built Distribution

jupytray-0.3-py3-none-any.whl (6.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page