Introduction¶
_ ______ ______
| | / / __ \/ ____/
| | / / /_/ / __/
| |/ / ____/ /___ The Vim Python Extensions
|___/_/ /_____/
VPE adds to Vim’s built-in support for Python scripting with the following aims.
Ability to write more Pythonic code.
Provide a toolkit of additional classes and functions to support complex plug-ins.
Be extremely compatible with existing Vim Python scripts.
Requirements¶
VPE requires a minimum of Vim 8.0.0700 and Python 3.6.
Installation¶
The VPE directory tree is structured as a package with a single plugin. Assuming your Vim files are in the “~/.vim” directory, add a “pack” sub-directory and install VPE into the “~/.vim/pack” directory. One way to do this is by simply cloning the VPE repository.
$ cd ~/.vim/pack
$ git clone https://github.com/paul-ollis/vim-vpe.git
or just unzip vim-vpe.zip.
$ cd ~/.vim/pack
$ unzip vim-vpe.zip
The package includes a “vim-vpe/start/vpe/plugin/vpe.vim” startup script that updates the Python path so that the vpe package can be imported.
User guide¶
- Getting started
- Using Buffers
- Using Windows
- The VPE and other logs
- Scratch buffers
- Handling keys, events, etc.
- Timers and deferred actions
- VPE plug-in mechanism
- Module vpe
- Module vpe.app_ui_support
- Module vpe.channels
- Module vpe.config
- Module vpe.core
- Module vpe.mapping
- Module vpe.panels
- Module vpe.syntax
- Module vpe.ui
- Module vpe.windows
- Module vpe.wrappers
- AutoCmdGroup
- BufEventHandler
- BufListener
- Buffer
- Buffers
- Callback
- CommandHandler
- CommandInfo
- Current
- EventHandler
- Finish
- GlobalOptions
- Log
- Options
- Popup
- PopupAtCursor
- PopupBeval
- PopupDialog
- PopupMenu
- PopupNotification
- Range
- Registers
- ScratchBuffer
- Struct
- TabPage
- TabPages
- Timer
- Variables
- Vim
- VimError
- Window
- Windows
- saved_current_window
- saved_winview
- temp_active_window
- call_soon
- call_soon_once
- define_command
- dot_vim_dir
- echo_msg
- error_msg
- find_buffer_by_name
- get_display_buffer
- highlight
- pedit
- popup_clear
- script_py_path
- timer_stopall
- version
- warning_msg