Skip to main content

UI tweaks for Jupyter application.

Project description

jupyter_ui_tweak

Github Actions Status

A JupyterLab extension that tweaks the UI with the following features:

  • New dropdown menu — Replaces the "New" dropdown button in the notebook tree view with one that lists available kernels sorted alphabetically by display name, instead of the default random order. Also includes shortcuts to create terminals, consoles, files, and directories.
  • Open in Voila — Adds an "Open In Voila" command to the file browser context menu for .ipynb files, opening the selected notebook in Voila.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyter_ui_tweak

Uninstall

To remove the extension, execute:

pip uninstall jupyter_ui_tweak

Contributing

See CONTRIBUTING.md for development setup and contribution guidelines.

AI Coding Assistant Support

This project includes an AGENTS.md file with coding standards and best practices for JupyterLab extension development. The file follows the AGENTS.md standard for cross-tool compatibility.

Compatible AI Tools

AGENTS.md works with AI coding assistants that support the standard, including Cursor, GitHub Copilot, Windsurf, Aider, and others. For a current list of compatible tools, see the AGENTS.md standard.

Other conventions you might encounter:

  • .cursorrules - Cursor's YAML/JSON format (Cursor also supports AGENTS.md natively)
  • CONVENTIONS.md / CONTRIBUTING.md - For CodeConventions.ai and GitHub bots
  • Project-specific rules in JetBrains AI Assistant settings

All tool-specific files should be symlinks to AGENTS.md as the single source of truth.

What's Included

The AGENTS.md file provides guidance on:

  • Code quality rules and file-scoped validation commands
  • Naming conventions for packages, plugins, and files
  • Coding standards (TypeScript)
  • Development workflow and debugging
  • Common pitfalls and how to avoid them

Customization

You can edit AGENTS.md to add project-specific conventions or adjust guidelines to match your team's practices. The file uses plain Markdown with Do/Don't patterns and references to actual project files.

Note: AGENTS.md is living documentation. Update it when you change conventions, add dependencies, or discover new patterns. Include AGENTS.md updates in commits that modify workflows or coding standards.

Packaging the extension

See RELEASE

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

jupyter_ui_tweak-0.1.4.tar.gz (116.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jupyter_ui_tweak-0.1.4-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_ui_tweak-0.1.4.tar.gz.

File metadata

  • Download URL: jupyter_ui_tweak-0.1.4.tar.gz
  • Upload date:
  • Size: 116.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for jupyter_ui_tweak-0.1.4.tar.gz
Algorithm Hash digest
SHA256 4dc39a835f304da448eddb011f571c73a2cf67b2f340433a26ec87cc7b618faa
MD5 7590f0a1c37072d26df79cd4ba35bb37
BLAKE2b-256 74c161efe4adf0b135cc47cb5e8ce73516e4cd630d17e6bcec1713ec7ac102be

See more details on using hashes here.

File details

Details for the file jupyter_ui_tweak-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyter_ui_tweak-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 84e429856d47771f3e6347ecb137acc79fe43e71710ae9d5f5f4cd4d3e32d027
MD5 0293af93f5fd436166bf6cd481e875f7
BLAKE2b-256 9825d4cc1d3f19c7e3bf25f04115d29ce5d71fcaa76424da1acdaaafdac5df0c

See more details on using hashes here.

Supported by

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