Skip to content

Installation Module

The installation module provides functions for installing and uninstalling the Jumper Wrapper Kernel specification.

Functions

Installation script for the Jumper Wrapper Kernel.

install_kernel(user=True, prefix=None)

Install the Jumper Wrapper Kernel specification.

Parameters:

Name Type Description Default
user

If True, install for current user only. Ignored if prefix is set.

 True
prefix

Install to specific prefix path (e.g., sys.prefix for virtualenv).

 None
Source code in jumper_wrapper_kernel/jumper_wrapper_kernel/install.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def install_kernel(user=True, prefix=None):
    """Install the Jumper Wrapper Kernel specification.

    Args:
        user: If True, install for current user only. Ignored if prefix is set.
        prefix: Install to specific prefix path (e.g., sys.prefix for virtualenv).
    """
    import tempfile
    import shutil

    kernel_spec_manager = KernelSpecManager()

    with tempfile.TemporaryDirectory() as temp_dir:
        kernel_json_path = os.path.join(temp_dir, 'kernel.json')

        with open(kernel_json_path, 'w') as f:
            json.dump(KERNEL_JSON, f, indent=2)

        # Add branded icons for the base launcher entry (full kangaroo icon)
        create_base_kernel_icons(Path(temp_dir))

        # Install the kernel spec
        if prefix:
            kernel_spec_manager.install_kernel_spec(
                temp_dir,
                kernel_name='jumper_wrapper',
                user=False,
                prefix=prefix
            )
        else:
            kernel_spec_manager.install_kernel_spec(
                temp_dir,
                kernel_name='jumper_wrapper',
                user=user
            )

    print(f"Jumper Wrapper Kernel installed successfully!")
    print(f"You can now use it by selecting 'Jumper Wrapper Kernel' in Jupyter.")

uninstall_kernel()

Remove the Jumper Wrapper Kernel specification.

Source code in jumper_wrapper_kernel/jumper_wrapper_kernel/install.py 
66
67
68
69
70
71
72
73
74
75
def uninstall_kernel():
    """Remove the Jumper Wrapper Kernel specification."""
    kernel_spec_manager = KernelSpecManager()

    try:
        kernel_spec_manager.remove_kernel_spec('jumper_wrapper')
        print("Jumper Wrapper Kernel uninstalled successfully!")
    except Exception as e:
        print(f"Failed to uninstall kernel: {e}")
        sys.exit(1)

main()

CLI entry point for kernel installation and removal.

Source code in jumper_wrapper_kernel/jumper_wrapper_kernel/install.py 
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
def main():
    """CLI entry point for kernel installation and removal."""
    parser = argparse.ArgumentParser(description='Install/Uninstall Jumper Wrapper Kernel')
    parser.add_argument('action', choices=['install', 'uninstall'], help='Action to perform')
    parser.add_argument('--user', action='store_true', default=True,
                        help='Install for the current user (default)')
    parser.add_argument('--sys-prefix', action='store_true',
                        help='Install to sys.prefix (e.g., for virtualenv/conda)')
    parser.add_argument('--prefix', type=str,
                        help='Install to a specific prefix')

    args = parser.parse_args()

    if args.action == 'install':
        if args.sys_prefix:
            install_kernel(user=False, prefix=sys.prefix)
        elif args.prefix:
            install_kernel(user=False, prefix=args.prefix)
        else:
            install_kernel(user=args.user)
    elif args.action == 'uninstall':
        uninstall_kernel()