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.



  • 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 INFILE OUTFILE  # launch local challenge
  vimgolf put CHALLENGE_ID      # launch challenge
  vimgolf list [PAGE][:LIMIT]   # list challenges
  vimgolf show CHALLENGE_ID     # show challenge
  vimgolf diff CHALLENGE_ID     # show diff for challenge
  vimgolf version               # display the version number

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



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.

Files for vimgolf, version 0.4.1
Filename, size File type Python version Upload date Hashes
Filename, size vimgolf-0.4.1-py3-none-any.whl (16.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size vimgolf-0.4.1.tar.gz (16.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page