Snapshot of neovim/pynvim: 1.7k★, Python. Python client and plugin host for Nvim
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Pynvim implements support for python plugins in Nvim. It also works as a library for
connecting to and scripting Nvim processes through its msgpack-rpc API.
Install
Supports python 3.10 or later.
Installation option #1: install using uv (recommended):
Install uv.
Install pynvim (the --upgrade switch ensures installation of the latest
version):
uv tool install --upgrade pynvim
Anytime you upgrade Neovim, make sure to upgrade pynvim as well by
re-running the above command.
Installation option #2: install using pipx:
Install pipx (https://pipx.pypa.io/stable/).
Install pynvim:
pipx install pynvim
Anytime you upgrade Neovim, make sure to upgrade pynvim as well by
running:
pipx upgrade pynvim
Other installation options:
See pynvim installation
documentation
for additional installation options and information.
Python Plugin API
Pynvim supports python remote plugins (via the language-agnostic Nvim rplugin
interface), as well as Vim plugins (via the :python3 interface). Thus when
pynvim is installed Neovim will report support for the +python3 Vim feature.
The rplugin interface allows plugins to handle vimL function calls as well as
defining commands and autocommands, and such plugins can operate asynchronously
without blocking nvim. For details on the new rplugin interface,
see the Remote Plugin documentation.
Pynvim defines some extensions over the vim python API:
Builtin and plugin vimL functions are available as nvim.funcs
API functions are available as vim.api and for objects such as buffer.api
Lua functions can be defined using vim.exec_lua and called with vim.lua
Support for thread-safety and async requests.
See the Python Plugin API documentation for usage of this new functionality.
Known issues
As Nvim does not support
bindeval, accessing a Vimscript
dictionary from Python (via vim.vars, vim.vvars, Buffer.vars, etc)
returns a copy, not a reference. As a result, setting its fields directly will
not write them back into Nvim. Instead, the whole dictionary must be written as
one. This can be achieved by creating a short-lived temporary.
Example:
vim.vars['my_dict']['field1'] = 'value' # Does not work
my_dict = vim.vars['my_dict'] #
my_dict['field1'] = 'value' # Instead do
vim.vars['my_dict'] = my_dict #
Development
Use (and activate) a local virtualenv, for example:
The --headless argument tells nvim not to wait for a UI to connect.
Alternatively, use --embedwithout--headless if your client is a UI
and you want nvim to wait for your client to nvim_ui_attach before
continuing startup.
See the tests for more examples.
Release
Create a release commit with title Pynvim x.y.z
list significant changes in the commit message
bump the version in pynvim/_version.py
Push to master.
git push
Make a release on GitHub with the same commit/version tag and copy the message.
Run scripts/disable_log_statements.sh
Run pipx run build
(Validation) Diff the release tarball dist/pynvim-x.y.z.tar.gz against the previous one.
Fetch the previous tar.gz from https://pypi.org/manage/project/pynvim/releases/
Unzip both.
Unzip both.
Diff them with :DiffTool old/ new/ (plugin: https://github.com/deathbeam/difftool.nvim)
Run pipx run twine upload -r pypi dist/*
Assumes you have a pypi account with permissions.
Run scripts/enable_log_statements.sh or git reset --hard to restore the working dir.
Bump up to the next development version in pynvim/_version.py, with prerelease suffix dev0.
Releasing with bump-my-version
bump-my-version automates the process of updating version strings, creating git commits, and tagging releases.
Install bump-my-version:
If you haven't already, install the development dependencies:
pip install .[dev]
Bump the version:
To increment the version, use one of the following commands:
TopGit's last sync did not record any GitHub topics for neovim/pynvim. GitHub topics appear in the right sidebar of a repository page; that's the authoritative place to check.
How active is development on neovim/pynvim?
The most recent commit recorded on neovim/pynvim was 7 months ago, based on the GitHub push timestamp. The repository has 132 forks — one of the better signals of community interest.
How many stars does neovim/pynvim have?
neovim/pynvim has 1.7k GitHub stars — refresh the page for the live number, or check github.com/neovim/pynvim. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What is neovim/pynvim?
neovim/pynvim (neovim/pynvim) is a Python project on GitHub. From the project's own README: Python client and plugin host for Nvim
What language is neovim/pynvim written in?
neovim/pynvim is written primarily in Python. GitHub's language field is based on the largest share of bytes in the default branch.
Read full README in the tab above.
Curious whether pynvim is right for you?
Let ChatGPT, Claude, or Perplexity look into it — click below and see what AI actually says about pynvim.