Neovim Python Client

Implements support for Python plugins in Neovim. Also works as a library for connecting to and scripting Neovim processes through its msgpack-rpc API.

Getting started

• Installation
  • Using uv or pipx
  • Using manually created Python virtual environment
  • Install from source
  • Upgrade pynvim when upgrading Neovim
  • Explicitly choosing pynvim virtual environment
  • Installing outside of a virtual environment is deprecated

Usage

• Python Plugin API
  • Nvim API methods: vim.api
  • Vimscript functions: vim.funcs
  • Lua integration
  • Async calls
• Remote (new-style) plugins

API documentation

• Plugin Decorators
  • Plugin
  • Command
  • Autocmd
  • Function
• Nvim Class
• Buffer Class
• Window Class
• Tabpage Class

Development

• Development
  • Contributing
  • Troubleshooting
  • Usage through the Python REPL