Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
docs/images
README.md

README.md

Kite Python Assistant

Kite is an AI-powered programming assistant that helps you write Python code inside Atom. The Kite Engine needs to be installed in order for the package to work properly. The package itself provides the frontend that interfaces with the Kite Engine, which performs all the code analysis and machine learning.

Features

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
  • 👀 Advanced function signatures that show you not only the official signature of a function, but also the most popular ways other developers call the function
  • 🔍 Instant documentation for the symbol underneath your cursor

Requirements

  • macOS 10.11+, Windows 7+ or Linux
  • Atom v1.13.0+
  • Kite Engine

Installation

Installing the Kite Engine

macOS Instructions

  1. Download the installer and open the downloaded .dmg file.
  2. Drag the Kite icon into the Applications folder.
  3. Run Kite.app to start the Kite Engine.

Windows Instructions

  1. Download the installer and run the downloaded .exe file.
  2. The installer should run the Kite Engine automatically after installation is complete.

Installing the Kite Assistant for Atom

When running the Kite Engine for the first time, you'll be guided through a setup process which will allow you to install the Atom package. You can also install or uninstall the Atom package at any time using the Kite Engine's plugin manager.

Alternatively, you have 2 options to manually install the package:

  1. Search for "Kite" in Atom's built-in package manager and install from there.
  2. Run the command apm install kite in your terminal.

Learn more about Kite for Atom.

Usage

The following is a brief guide to using Kite in its default configuration.

Tutorial

When starting Atom with the Kite Assistant for the first time, you'll be guided through a tutorial that shows you how to use Kite.

tutorial

This tutorial will only be displayed once. You can show it again at any time by running the command Kite: Tutorial from Atom's command palette.

Hover

Hover your mouse cursor over a symbol to view a short summary of what the symbol represents.

hover

Documentation

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

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.

completions

Function Signatures

When you call a function, Kite will show you the arguments required to call it.

signature

Kite also shows you How others used this function, which are the most popular calling patterns inferred from all the open source code on the internet.

Commands

Kite comes with sevaral commands that you can run from Atom's command palette.

commands

Command Description
kite:open-copilot Open the Copilot
kite:docs-at-cursor Show documentation of the symbol underneath your cursor in the Copilot
kite:status Show the current status of Kite in the status panel
kite:package-settings Open the settings for the Kite Atom package
kite:engine-settings Open the settings for the Kite Engine
kite:tutorial Open the Kite tutorial file
kite:help Open Kite's help website in the browser

If you wish, you may also setup keybindings for the commands listed above.

Configuration

You can view and change the Kite Assistant's settings by finding Kite in your list of installed packages, then clicking the Settings button. Alternatively, you can run the command Kite: Package Settings from the command palette.

Contact Us

Feel free to contact us with bug reports, feature requests, or general comments at feedback@kite.com.

Happy coding!


About Kite

Kite is built by a team in San Francisco devoted to making programming easier and more enjoyable for all. Follow Kite on Twitter and get the latest news and programming tips on the Kite Blog. Kite has been featured in Wired, VentureBeat, The Next Web, and TechCrunch.

You can’t perform that action at this time.