Skip to content

Commit df22f07

Browse files
committed
Describe the pyls fork and IPython Jedi setting in README
1 parent d6f836e commit df22f07

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Language Server Protocol integration for Jupyter(Lab)
22

3-
![tests](https://github.com/krassowski/jupyterlab-lsp/workflows/tests/badge.svg) [![Documentation Status](https://readthedocs.org/projects/jupyterlab-lsp/badge/?version=latest)](https://jupyterlab-lsp.readthedocs.io/en/latest/?badge=latest) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/krassowski/jupyterlab-lsp/master?urlpath=lab%2Ftree%2Fexamples%2FPython.ipynb)
3+
![tests](https://github.com/krassowski/jupyterlab-lsp/workflows/CI/badge.svg) [![Documentation Status](https://readthedocs.org/projects/jupyterlab-lsp/badge/?version=latest)](https://jupyterlab-lsp.readthedocs.io/en/latest/?badge=latest) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/krassowski/jupyterlab-lsp/master?urlpath=lab%2Ftree%2Fexamples%2FPython.ipynb)
44

55
> _This project is still maturing, but you are welcome to check it out, leave feedback and/or a PR_
66
@@ -121,6 +121,7 @@ Use of a python `virtualenv` or a conda env is also recommended.
121121
R ([languageserver](https://github.com/REditorSupport/languageserver)) servers:
122122

123123
```bash
124+
# note: you may want to use our fork of python-language-server instead (see below)
124125
pip install 'python-language-server[all]'
125126
R -e 'install.packages("languageserver")'
126127
```
@@ -138,9 +139,33 @@ Use of a python `virtualenv` or a conda env is also recommended.
138139
[Microsoft list](https://microsoft.github.io/language-server-protocol/implementors/servers/)
139140
should work after [some additional configuration](./CONTRIBUTING.md#specs).
140141

141-
Note: it is worth visiting the repository of each server you install as
142+
Note 1: it is worth visiting the repository of each server you install as
142143
many provide additional configuration options.
143144

145+
Note 2: we are developing an improved (faster autocompletion, added features)
146+
version of the `python-language-server`. It is experimental and should
147+
not be used in production yet, but will likely benefit individual users
148+
You can check it out with:
149+
150+
```bash
151+
pip install git+https://github.com/krassowski/python-language-server.git@main
152+
```
153+
154+
Please report any regressions [here](https://github.com/krassowski/jupyterlab-lsp/issues/272).
155+
156+
1. (Optional, IPython users only) to improve the performance of autocompletion,
157+
disable Jedi in IPython (the LSP servers for Python use Jedi too).
158+
You can do that temporarily with:
159+
160+
```ipython
161+
%config Completer.use_jedi = False
162+
```
163+
164+
or permanently by setting `c.Completer.use_jedi = False` in your
165+
[`ipython_kernel_config.py` file](https://ipython.readthedocs.io/en/stable/config/intro.html?highlight=ipython_kernel_config.py#systemwide-configuration).
166+
You will also benefit from using experimental version of python-language-server
167+
as described in the Note 2 (above).
168+
144169
1. (Optional, Linux/OSX-only) to enable opening files outside of the root
145170
directory (the place where you start JupyterLab), create `.lsp_symlink` and
146171
symlink your `/home`, or any other location which includes the files that you

0 commit comments

Comments
 (0)