How to add libraries to the Kite index

How do I add installed libraries to the Kite index?

If you do not see completions or documentation for 3rd party libraries you have installed, you may need to add them manually to Kite's index. Please follow the instructions below to learn how to do so.

macOS and Linux

First, make sure that there exists a libraries directory in the Kite config directory.

mkdir -p ~/.kite/libraries

Next, create a symbolic link to the site-packages folder that you want indexed by Kite.

For the purposes of this example, let's assume you have a virtual environment called my_env and that the libraries for my_env have been installed at /path/to/my_env/site-packages.

To add these libraries to Kite's index, run the following command:

ln -s /path/to/my_env/site-packages/ ~/.kite/libraries/my_env

Make sure that the installed libraries show up after running the command:

ls ~/.kite/libraries/my_env/

Finally, restart Kite for the changes to take effect.

Windows

First, make sure that there exists a libraries directory in the Kite config directory.

md %USERPROFILE%\AppData\Local\Kite\libraries

Next, create a symbolic link to the site-packages folder that you want indexed by Kite.

For the purposes of this example, let's assume you have a virtual environment called my_env and that the libraries for my_env have been installed at \path\to\my_env\site-packages.

To add these libraries to Kite's index, run the following command:

mklink /D %USERPROFILE%\AppData\Local\Kite\libraries\my_env \path\to\my_env\site-packages

Make sure that the installed libraries show up after running the command:

dir %USERPROFILE%\AppData\Local\Kite\libraries\my_env

Finally, restart Kite for the changes to take effect.

Why can't Kite find my installed libraries?

Due to privacy concerns, Kite never searches for libraries in the following directories:

• Windows: Directories that contain \\appdata.
• Linux: Hidden directories (directories that start with .) and directories underneath /usr, /dev, /tmp, /opt, and /sbin.
• macOS: Directories underneath /usr, /dev, /tmp, /opt, /private, and /sbin. All Applications, Calendar, Library, Pictures, and Trash directories are excluded as well.

If you have libraries installed in these forbidden directories, then you will need to add those libraries manually via the instructions above. To determine where your library is installed, you can run the following lines of code in the Python shell:

import package_name
print(package_name.__file__)