submizeVim

submizeVim is a tiny Python helper for running Vim Ex commands against a file in the current working directory.

Install

pip install submizeVim

Vim must be installed and available on PATH.

Usage

import submizeVim

submizeVim.vim_do("hello.txt", "%s/old/new/g")

The first argument is the file name relative to the current folder. The second argument is a string containing one or more Vim commands. Multiple commands can be separated by newlines:

submizeVim.vim_do(
    "hello.txt",
    """
    %s/foo/bar/g
    normal! gg
    """
)

By default, vim_do writes the file after the commands finish. It returns a VimResult object with returncode, stdout, stderr, file, and cwd. It also prints short terminal hints by default. If Vim is missing, Vim fails, or Vim runs longer than the default 30-second timeout, it raises a clear exception instead of waiting forever.

submizeVim.vim_do("hello.txt", "%s/old/new/g", timeout=10)
submizeVim.vim_do("hello.txt", "%s/old/new/g", verbose=False)

CLI

submizevim hello.txt "%s/old/new/g"

Notes

This library does not execute commands through a shell. It writes the Vim commands to a temporary Vim script and runs Vim in Ex mode.