blob: 3fc264cc65aad110bbcf78c18a9f3597fc660332 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
.. pygls documentation master file, created by
sphinx-quickstart on Sun Nov 25 16:16:27 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
*pygls*
=======
`pygls`_ (pronounced like “pie glass”) is a generic implementation of
the `Language Server Protocol`_ written in the Python programming language. It
allows you to write your own `language server`_ in just a few lines of code.
Features
--------
- cross-platform support
- TCP/IP and STDIO communication
- runs in asyncio event loop
- register LSP features and custom commands as:
- asynchronous functions (coroutines)
- synchronous functions
- functions that will be executed in separate thread
- thread management
- in-memory workspace with *full* and *incremental* document updates
- type-checking
- good test coverage
Python Versions
---------------
*pygls* works with Python 3.8+.
User Guide
----------
.. toctree::
:maxdepth: 2
pages/getting_started
pages/tutorial
pages/user-guide
pages/testing
pages/migrating-to-v1
pages/reference
.. _Language Server Protocol: https://microsoft.github.io/language-server-protocol/specification
.. _Language server: https://langserver.org/
.. _pygls: https://github.com/openlawlibrary/pygls
|
