Skip to main content

A vimgolf client written in Python

Project description

vimgolf

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.

Installation

Requirements

  • Python 3.5 or greater

Install

$ pip3 install vimgolf

Update

$ pip3 install --upgrade vimgolf

Usage

Launch

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

Commands

  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 vimgolf.com challenge
  vimgolf list [PAGE][:LIMIT]   # list vimgolf.com challenges
  vimgolf show CHALLENGE_ID     # show vimgolf.com challenge
  vimgolf version               # display the version number

CHALLENGE_ID can be a 24-character ID from vimgolf.com, 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.

Demo

License

The source code has an MIT License.

See 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.1.9.tar.gz (14.4 kB view details)

Uploaded Source

File details

Details for the file vimgolf-0.1.9.tar.gz.

File metadata

  • Download URL: vimgolf-0.1.9.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.1.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

File hashes

Hashes for vimgolf-0.1.9.tar.gz
Algorithm Hash digest
SHA256 e705e24e168245ad2d0d5bd7bac1c988c790d66f0086913ab345adb891711def
MD5 bb124db295723b1a2179989c537f1b47
BLAKE2b-256 3fad92ccd59e13ddd81ad69ab8a8103a405e5047e3cfdf041c707ea1036ef22e

See more details on using hashes here.

Supported by

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