2.7k GitHub stars and counting — palantir/python-language-server is a Python project TopGit is tracking across repositories on the platform. An implementation of the Language Server Protocol for Python
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.
A Python 2.7 and 3.5+ implementation of the Language Server Protocol_.
Installation
The base language server requires Jedi_ to provide Completions, Definitions, Hover, References, Signature Help, and
Symbols:
pip install python-language-server
If the respective dependencies are found, the following optional providers will be enabled:
Rope_ for Completions and renaming
Pyflakes_ linter to detect various errors
McCabe_ linter for complexity checking
pycodestyle_ linter for style checking
pydocstyle_ linter for docstring style checking (disabled by default)
autopep8_ for code formatting
YAPF_ for code formatting (preferred over autopep8)
Optional providers can be installed using the extras syntax. To install YAPF_ formatting for example:
pip install 'python-language-server[yapf]'
All optional providers can be installed using:
pip install 'python-language-server[all]'
If you get an error similar to 'install_requires' must be a string or list of strings then please upgrade setuptools before trying again.
pip install -U setuptools
3rd Party Plugins
Installing these plugins will add extra functionality to the language server:
* pyls-mypy_ Mypy type checking for Python 3
* pyls-isort_ Isort import sort code formatting
* pyls-black_ for code formatting using Black_
Please see the above repositories for examples on how to write plugins for the Python Language Server. Please file an
issue if you require assistance writing a plugin.
Configuration
-------------
Configuration is loaded from zero or more configuration sources. Currently implemented are:
* pycodestyle: discovered in ~/.config/pycodestyle, setup.cfg, tox.ini and pycodestyle.cfg.
* flake8: discovered in ~/.config/flake8, setup.cfg, tox.ini and flake8.cfg
The default configuration source is pycodestyle. Change the `pyls.configurationSources` setting to `['flake8']` in
order to respect flake8 configuration instead.
Overall configuration is computed first from user configuration (in home directory), overridden by configuration
passed in by the language client, and then overriden by configuration discovered in the workspace.
To enable pydocstyle for linting docstrings add the following setting in your LSP configuration:
```
"pyls.plugins.pydocstyle.enabled": true
```
See `vscode-client/package.json`_ for the full set of supported configuration options.
.. _vscode-client/package.json: vscode-client/package.json
Language Server Features
------------------------
Auto Completion:
.. image:: https://raw.githubusercontent.com/palantir/python-language-server/develop/resources/auto-complete.gif
Code Linting with pycodestyle and pyflakes:
.. image:: https://raw.githubusercontent.com/palantir/python-language-server/develop/resources/linting.gif
Signature Help:
.. image:: https://raw.githubusercontent.com/palantir/python-language-server/develop/resources/signature-help.gif
Go to definition:
.. image:: https://raw.githubusercontent.com/palantir/python-language-server/develop/resources/goto-definition.gif
Hover:
.. image:: https://raw.githubusercontent.com/palantir/python-language-server/develop/resources/hover.gif
Find References:
.. image:: https://raw.githubusercontent.com/palantir/python-language-server/develop/resources/references.gif
Document Symbols:
.. image:: https://raw.githubusercontent.com/palantir/python-language-server/develop/resources/document-symbols.gif
Document Formatting:
.. image:: https://raw.githubusercontent.com/palantir/python-language-server/develop/resources/document-format.gif
Development
-----------
To run the test suite:
``pip install .[test] && pytest``
Develop against VS Code
=======================
The Python language server can be developed against a local instance of Visual Studio Code.
Install `VSCode <https://code.visualstudio.com/download>`_
.. code-block:: bash
# Setup a virtual env
virtualenv env
. env/bin/activate
# Install pyls
pip install .
# Install the vscode-client extension
cd vscode-client
yarn install
# Run VSCode which is configured to use pyls
# See the bottom of vscode-client/src/extension.ts for info
yarn run vscode -- $PWD/../
Then to debug, click View -> Output and in the dropdown will be pyls.
To refresh VSCode, press `Cmd + r`
License
-------
This project is made available under the MIT License.
.. _Language Server Protocol: https://github.com/Microsoft/language-server-protocol
.. _Jedi: https://github.com/davidhalter/jedi
.. _Rope: https://github.com/python-rope/rope
.. _Pyflakes: https://github.com/PyCQA/pyflakes
.. _McCabe: https://github.com/PyCQA/mccabe
.. _pycodestyle: https://github.com/PyCQA/pycodestyle
.. _pydocstyle: https://github.com/PyCQA/pydocstyle
.. _YAPF: https://github.com/google/yapf
.. _autopep8: https://github.com/hhatto/autopep8
.. _pyls-mypy: https://github.com/tomv564/pyls-mypy
.. _pyls-isort: https://github.com/paradoxxxzero/pyls-isort
.. _pyls-black: https://github.com/rupert/pyls-black
.. _Black: https://github.com/ambv/black
Does palantir/python-language-server have a project website?
No homepage URL was recorded for palantir/python-language-server in TopGit's last sync. The README tab above frequently contains screenshots and demo links, or check the repository description on GitHub.
How active is development on palantir/python-language-server?
The most recent commit recorded on palantir/python-language-server was 1 month ago, based on the GitHub push timestamp. The repository has 291 forks — one of the better signals of community interest.
Is palantir/python-language-server open source?
Yes — palantir/python-language-server ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/palantir/python-language-server.
What license does palantir/python-language-server use?
palantir/python-language-server is released under the MIT license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
What topics is palantir/python-language-server associated with?
GitHub's repository topics for palantir/python-language-server: "octo-correct-managed". TopGit's editorial category is open-source.
Where do I read more about palantir/python-language-server?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/palantir/python-language-server is the definitive source.
Read full README in the tab above.
Want a second opinion on python-language-server?
Ask an AI that can read this page — one click and you get its take on python-language-server.
/python-language-server