File: README.md

package info (click to toggle)
ycmd 0%2B20201028%2Bgit1d415c5%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 4,836 kB
  • sloc: python: 39,750; cpp: 5,991; java: 275; sh: 255; cs: 194; javascript: 150; ansic: 82; makefile: 47; xml: 18; objc: 10
file content (25 lines) | stat: -rw-r--r-- 886 bytes parent folder | download | duplicates (4)
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
# ycmd example client

The example client **requires** Python 3.6+.

First make sure you have built ycmd; see the top-level README for details.

Then install all the Python requirements with [pip][] (run as admin/super user):

```
pip install -r requirements.txt --use-mirrors
```

Then just run `./example_client.py` from the console. It will start `ycmd`, send
it some example requests while logging the full HTTP request & response and then
shut everything down.

The best way to learn how to use ycmd is to play around with the example client;
tweak the code, send other requests etc. Start by looking at the `Main()`
function at the bottom of the file.

NOTE: Everything in this folder and below is licensed under the [Apache2
license][apache], not the GPLv3 like the rest of ycmd.

[pip]: http://pip.readthedocs.org/en/latest/
[apache]: http://www.apache.org/licenses/LICENSE-2.0