2019-01-16 08:51:16 +03:00
|
|
|
# Kite Python Assistant for Visual Studio Code
|
2017-03-22 04:46:11 +03:00
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
Kite is an AI-powered programming assistant that helps you write Python code inside Visual Studio Code. The
|
|
|
|
[Kite Engine](https://kite.com/) needs to be installed in order for the extension to work properly. The extension itself
|
|
|
|
provides the frontend that interfaces with the Kite Engine, which performs all the code analysis and machine learning.
|
2017-03-22 04:46:11 +03:00
|
|
|
|
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
## Features
|
2017-03-22 04:46:11 +03:00
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
Kite's goal is to help you write code faster by showing you the right information at the right time. At a high level,
|
|
|
|
Kite provides you with:
|
|
|
|
* 🧠 __Smart autocompletions__ powered by machine learning models trained on the entire open source code universe
|
|
|
|
* 👀 __Function signatures__ that show you the official signature of a function you're currently using
|
|
|
|
* 🔍 __Instant documentation__ for the symbol underneath your cursor
|
2017-03-22 04:46:11 +03:00
|
|
|
|
2017-11-06 21:25:52 +03:00
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
## Requirements
|
2017-11-06 21:25:52 +03:00
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
* macOS 10.10+ or Windows 7+
|
|
|
|
* Visual Studio Code v1.28.0+
|
|
|
|
* [Kite Engine](https://kite.com/)
|
2017-11-06 21:25:52 +03:00
|
|
|
|
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
## Installation
|
2017-11-06 21:25:52 +03:00
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
### Installing the Kite Engine
|
2017-11-06 21:25:52 +03:00
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
__macOS Instructions__
|
|
|
|
1. Download the [installer](https://kite.com/download) and open the downloaded `.dmg` file.
|
|
|
|
2. Drag the Kite icon into the `Applications` folder.
|
|
|
|
3. Run `Kite.app` to start the Kite Engine.
|
2017-11-06 21:25:52 +03:00
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
__Windows Instructions__
|
|
|
|
1. Download the [installer](https://kite.com/download) and run the downloaded `.exe` file.
|
|
|
|
2. The installer should run the Kite Engine automatically after installation is complete.
|
2017-11-06 21:25:52 +03:00
|
|
|
|
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
### Installing the Kite Assistant for Visual Studio Code
|
2017-11-06 21:25:52 +03:00
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
When running the Kite Engine for the first time, you'll be guided through a setup process which will allow you to install
|
|
|
|
the VS Code extension. You can also install or uninstall the VS Code extension at any time using the Kite Engine's [plugin
|
|
|
|
manager](https://help.kite.com/article/62-managing-editor-plugins).
|
2017-11-06 21:25:52 +03:00
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
Alternatively, you have 2 options to manually install the package:
|
|
|
|
1. Search for "Kite" in VS Code's built-in extension marketplace and install from there.
|
|
|
|
2. Run the command `code --install-extension kiteco.kite` in your terminal.
|
2017-11-06 21:25:52 +03:00
|
|
|
|
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
## Usage
|
2017-11-06 21:25:52 +03:00
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
The following is a brief guide to using Kite in its default configuration.
|
2017-11-06 21:25:52 +03:00
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
### Hover
|
2017-11-06 21:25:52 +03:00
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
Hover your mouse cursor over a symbol to view a short summary of what the symbol represents.
|
2017-11-06 21:25:52 +03:00
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
![hover](https://s3.amazonaws.com/helpscout.net/docs/assets/589ced522c7d3a784630c348/images/5c3eb72c2c7d3a3194501270/file-LaHSHhYTkH.png)
|
2017-11-06 21:25:52 +03:00
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
### Documentation
|
2017-11-06 21:25:52 +03:00
|
|
|
|
2019-01-16 08:51:16 +03:00
|
|
|
Click on the `Docs` link in the hover popup to open the documentation for the symbol inside the Copilot, Kite's standalone
|
|
|
|
reference tool.
|
|
|
|
|
|
|
|
![copilot](https://github.com/kiteco/atom-plugin/blob/master/docs/images/copilot.png?raw=true)
|
|
|
|
|
|
|
|
### Definitions
|
|
|
|
|
|
|
|
If a `Def` link is available in the hover popup, clicking on it will jump to the definition of the symbol.
|
|
|
|
|
|
|
|
### Autocompletions
|
|
|
|
|
|
|
|
Simply start typing in a saved Python file and Kite will automatically suggest completions for what you're typing. Kite's
|
|
|
|
autocompletions are all labeled with the `⟠` symbol.
|
|
|
|
|
|
|
|
![completions](https://s3.amazonaws.com/helpscout.net/docs/assets/589ced522c7d3a784630c348/images/5c3eb54f04286304a71e4292/file-jJZznGIq2t.png)
|
|
|
|
|
|
|
|
### Function Signatures
|
|
|
|
|
|
|
|
When you call a function, Kite will show you the arguments required to call it. Kite's function signatures are also all
|
|
|
|
labeled with the `⟠` symbol.
|
|
|
|
|
|
|
|
![signature](https://s3.amazonaws.com/helpscout.net/docs/assets/589ced522c7d3a784630c348/images/5c3eb6ad2c7d3a319450126e/file-j1bl9zETcx.png)
|
|
|
|
|
|
|
|
> __Note:__ If you have the Microsoft Python extension installed, Kite will _not_ be able to show you information on
|
|
|
|
> function signatures.
|
|
|
|
|
|
|
|
### Commands
|
|
|
|
|
|
|
|
Kite comes with sevaral commands that you can run from VS Code's command palette.
|
|
|
|
|
|
|
|
|Command|Description|
|
|
|
|
|:---|:---|
|
2019-01-17 07:14:13 +03:00
|
|
|
|`kite.open-copilot`|Open the Copilot|
|
|
|
|
|`kite.docs-at-cursor`|Show documentation of the symbol underneath your cursor in the Copilot|
|
|
|
|
|`kite.engine-settings`|Open the settings for the Kite Engine|
|
|
|
|
|`kite.help`|Open Kite's help website in the browser|
|
2019-01-16 08:51:16 +03:00
|
|
|
|
|
|
|
|
|
|
|
## Contact Us
|
|
|
|
|
|
|
|
Feel free to contact us with bug reports, feature requests, or general comments at feedback@kite.com.
|
|
|
|
|
|
|
|
Happy coding!
|