scriptsmenu

Searchable scripts menu with search field in Qt

Scriptsmenu will help you to easily organize your scripts into a customizable menu that users can quickly browse and search.

Features

• Built with Qt.py
• Searchable menu for your scripts and tools (using tags)
• Update your scripts menu without restarting application
• Supports use of relative paths for scripts

Installation

To install download this package and place it on your PYTHONPATH.

Usage

To build a simple menu of searchable scripts

from scriptsmenu import ScriptsMenu

menu = ScriptsMenu(title="Scripts",
                   parent=None)
menu.add_script(parent=menu,
                title="Script A",
                command="print('A')",
                sourcetype='',
                tags=["foobar", "nugget"])
menu.add_script(parent=menu,
                title="Script B",
                command="print('B')",
                sourcetype='',
                tags=["gold", "silver", "bronze"])
menu.show()

Example usage in Autodesk Maya

To parent the scripts menu to an application you'll need a parent Qt widget from the host application. You can pass this parent as parent to the ScriptMenu(parent=parent).

Additionally if you want to alter the behavior when clicking a menu item with specific modifier buttons held (e.g. Control + Shift) you can register a callback. See the Register callback example under Advanced below.

An example for Autodesk Maya can be found in launchformaya.py

To show the menu in Maya:

import scriptsmenu.launchformaya as launchformaya

menu = launchformaya.main(title="My Scripts")

# continue to populate the menu here

This will automatically parent it to Maya's main menu bar.

To show the menu at Maya launch you can add code to your userSetup.py. This code will need to be executed deferred to ensure it runs when Maya main menu bar already exist. For example:

import maya.utils
import scriptsmenu.launchformaya as launchformaya

def build_menu():
    menu = launchformaya.main(title="My Scripts")

maya.utils.executeDeferred(build_menu)

An example for The Foundry Nuke can be found in launchfornuke.py

To show the menu in Nuke:

import scriptsmenu.launchfornuke as launchfornuke

menu = launchfornuke.main(title="My Scripts")

menu.add_script(parent=menu,
                title="Script A",
                command="print('A')",
                sourcetype='',
                tags=["foobar", "nugget"])

menu.add_script(parent=menu,
                title="Script B",
                command="print('B')",
                sourcetype='',
                tags=["gold", "silver", "bronze"])

Advanced

Relative paths

To use relative paths in your scripts and icons you can use environment variables. Ensure the environment variable is set correctly and use it in the paths, like $YOUR_ENV_VARIABLE.

A relative path for example could be set as $SCRIPTS/relative/path/to/script.py An example of this can be found in the samples folder of this package.

Register callback

You can override the callback behavior per modifier state. For example when you want special behavior when a menu item is clicked with Control + Shift held at the same time.

from Qt import QtCore
from scriptsmenu import ScriptsMenu

def callback(action):
    """This will print a message prior to running the action"""
    print("Triggered with Control + Shift")
    action.run_command()

# Control + Shift
modifier = QtCore.Qt.ControlModifier | QtCore.Qt.ShiftModifier

menu = ScriptsMenu()
menu.register_callback(modifier, callback)