Skip to content

Commit 49141cc

Browse files
committed
Add requirements in docs
1 parent a2ef68a commit 49141cc

2 files changed

Lines changed: 17 additions & 19 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ Python REPL inside Neovim powered by Jupyter console!
44

55
<img width="1608" height="1057" alt="image" src="https://github.com/user-attachments/assets/1cabf303-9840-4274-9c51-ab14424e8e99" />
66

7+
## Requirements
8+
9+
- Python 3.12+
10+
- Neovim 0.11+
11+
- Optional Python packages:
12+
- [cairosvg](https://cairosvg.org/) for displaying SVG images
13+
- [pillow](https://github.com/python-pillow/Pillow) for displaying JPG images
14+
715
## Quickstart
816

917
Minimal `vim.pack` setup with the default config and example keymaps:

doc/pyrepl.txt

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,15 @@ Features `pyrepl.nvim` currently provides:
1616
- Jupytext cell navigation;
1717
- Toggle focus to REPL window in active terminal mode.
1818

19+
------------------------------------------------------------------------------
20+
REQUIREMENTS *pyrepl-reqs*
21+
22+
- Python 3.12+
23+
- Neovim 0.11+
24+
- Optional Python packages:
25+
- cairosvg (for displaying SVG images)
26+
- pillow (for displaying JPG images)
27+
1928
------------------------------------------------------------------------------
2029
QUICKSTART *pyrepl-quickstart*
2130

@@ -75,25 +84,6 @@ Then install REPL runtime packages with `uv` or `pip` directly from Neovim:
7584
:PyreplInstall uv
7685
<
7786

78-
==============================================================================
79-
REQUIREMENTS *pyrepl-reqs*
80-
81-
- A working Python executable. By default pyrepl.nvim uses `python`
82-
executable from PATH.
83-
You can override it with `python_path` (see |pyrepl-config|).
84-
- The selected Python interpreter must have these packages:
85-
- pynvim
86-
- jupyter-console
87-
- Optional for images:
88-
- pillow (JPEG -> PNG conversion)
89-
- cairosvg (SVG -> PNG conversion)
90-
- A Jupyter kernel is registered (optional, for global kernels):
91-
92-
>
93-
python3 -m pip install ipykernel
94-
python3 -m ipykernel install --user --name python3
95-
<
96-
9787
==============================================================================
9888
COMMANDS *pyrepl-commands*
9989

0 commit comments

Comments
 (0)