/pycompletefunc

Primary LanguageVim script

Pycompletefunc

A minimal plugin focused on Python completion

Table of Contents

About The Project

Product Name Screen Shot

This is a lightweight and fast VIM plugin to handle Python code completion. It provides one function named pycompletefunc#CompleteFunc and uses it to set the completefunc VIM option for Python files.

Plugin goals

  • Stay focused: Provide a Python completion function to override completefunc exclusively.
  • Stay fast: Speed is important and typing should never be blocked until completion options arrive.
  • Defer to VIM: VIM already has keybindings Ctrl-X Ctrl-U with a popup for displaying completion options. This plugin should work with those existing features and won't create new keybindings or custom popups.
  • Manage dependencies: Install and manage completion dependencies like Jedi for plugin users

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Make sure VIM is installed with the python 3 extension. You can verify this by running vim --version at a bash prompt and looking for +python3 in the output.

Installation

You can install this package using a VIM package manager like vim-plug or using VIM 8's native package loading

Example .vimrc update to install using vim-plug:

Plug 'denheck/pycompletefunc'

Usage

Once installed the builtin VIM command for executing a user defined completion (CTRL-X CTRL-U) will open the options dropdown. Options can be cycled through using CTRL-N and CTRL-P. For more information on user defined completion in VIM the documentation has you covered. See :help ins-completion or :help compl-function

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

Thanks to the following exemplary projects for inspiration. If this plugin doesn't suit your needs you should definitely use one of the following