Using the Spyder plugin
In this article, you'll learn how to access all the features in Kite for Spyder. Kite is an AI-powered completions engine that runs entirely locally on your machine.
Please note that Kite is available only in Spyder beta builds right now. Please install Spyder's development build and refer to Spyder's Github repo for further installation instructions.
If you'd prefer to be notified once Kite is live on Spyder 4.0 (post beta), sign up here and indicate Python and Spyder for your language and editor preferences.
The only prerequisites are that you have Kite Engine running and have chosen Kite as your Spyder completions provider. Here are steps to do so:
- Install and run Kite at https://kite.com/download/
- Enable completions at Preferences > Completions and linting > Completion. Make sure all checkboxes here are checked. For optimal experience, we recommend changing the values here to the ones in the screenshot below.
- Show automatic completions after characters entered: 1
- Show automatic completions after keyboard idle (ms): 100
- Check the checkbox at Preferences > Completions and linting > Advanced > Enable Kite (if the Kite engine is running)
Checking the status of Kite
If Kite is installed properly, you should see a text indicator at the bottom of the Spyder window.
There are a handful of possible states Kite can be in, as described in the following table:
|Kite: not running||Kite Engine is not running.|
|Kite: Indexing||Kite is analyzing your code.|
|Kite: Ready||Kite is ready to go - start coding!|
Note: If you're running Kite for the first time, it may take several minutes for Kite to finish indexing your codebase.
Writing code and accessing features
In the following sections, the ‸ character indicates the position of your editor's text cursor.
To start, open a Python file. Make sure that this file has been saved with a
.py extension. Now type the following code:
A list of suggested completions should automatically appear.
Kite can provide completions for Python keywords, name expressions, functions, and even snippets. Here, Kite recognizes that data scientists often use the
np alias to represent
numpy, and saves you keystrokes. The example above illustrates a name expression completion. An example of a function completions would be:
import numpy as np np.l‸
Kite will also show hints for the kind of value represented by the completion (e.g.
function) as well as a short snippet of the documentation if available.
Kite is much more than just a completions engine. The Kite Copilot includes look up information while you code, saving you time and distractions from a typical browser search. In the GIF below, Kite follows your cursor to automatically show you relevant documentation, such as your library imports. Learn more about the Kite Copilot and its functionality.
To get the functionality above, enable "Click for docs to follow cursor" in the top right corner of the Kite Copilot.