1# ycmd example client
2
3The example client **requires** Python 3.6+.
4
5First make sure you have built ycmd; see the top-level README for details.
6
7Then install all the Python requirements with [pip][] (run as admin/super user):
8
9```
10pip install -r requirements.txt --use-mirrors
11```
12
13Then just run `./example_client.py` from the console. It will start `ycmd`, send
14it some example requests while logging the full HTTP request & response and then
15shut everything down.
16
17The best way to learn how to use ycmd is to play around with the example client;
18tweak the code, send other requests etc. Start by looking at the `Main()`
19function at the bottom of the file.
20
21NOTE: Everything in this folder and below is licensed under the [Apache2
22license][apache], not the GPLv3 like the rest of ycmd.
23
24[pip]: http://pip.readthedocs.org/en/latest/
25[apache]: http://www.apache.org/licenses/LICENSE-2.0
26