Skip to main content

A vimgolf client written in Python

Project description

Build Status


This project contains a vimgolf client written in Python.

The user interface is similar to the official vimgolf client, with a few additions inspired by vimgolf-finder, and an optional way to specify keys to type when launching a challenge.



  • Python 3.5 or greater


$ pip3 install vimgolf


$ pip3 install --upgrade vimgolf



If the launcher script was installed within a directory on your PATH, vimgolf can be launched directly.

$ vimgolf

Otherwise, vimgolf can be launched by passing its module name to Python.

$ python3 -m vimgolf


  vimgolf [help]                # display this help and exit
  vimgolf config [API_KEY]      # configure your VimGolf credentials
  vimgolf local IN OUT [KEYS]   # launch local challenge
  vimgolf put CHALLENGE [KEYS]  # launch challenge
  vimgolf list [PAGE][:LIMIT]   # list challenges
  vimgolf show CHALLENGE        # show challenge
  vimgolf diff CHALLENGE        # show diff for challenge
  vimgolf version               # display the version number

CHALLENGE can be a 24-character ID from, or a plus-prefixed ID corresponding to the last invocation of vimgolf list. For example, a CHALLENGE of +6 would correspond to the sixth challenge presented in the most recent call to vimgolf list.

For the local command, IN and OUT are paths to files.

For the local and put commands, the optional KEYS specifies a set of keys to enter when launching the challenge. For example, ihello world<esc> would enter insert mode, type "hello world", and then switch back to normal mode. The character < is assumed to start a special sequence (e.g., <esc>) if that would be possible given the characters that follow. The input string should use <lt> to disambiguate.



The source code has an MIT License.


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vimgolf-0.5.1.tar.gz (20.6 kB view hashes)

Uploaded Source

Built Distribution

vimgolf-0.5.1-py3-none-any.whl (18.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page