Skip to main content

A vimgolf client written in Python

Project description

Build Status

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, and an optional way to specify keys to type when launching a challenge.

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 IN OUT [KEYS]   # launch local challenge
  vimgolf put CHALLENGE [KEYS]  # launch vimgolf.com challenge
  vimgolf list [PAGE][:LIMIT]   # list vimgolf.com challenges
  vimgolf show CHALLENGE        # show vimgolf.com challenge
  vimgolf diff CHALLENGE        # show diff for vimgolf.com challenge
  vimgolf version               # display the version number

CHALLENGE 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 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.

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.5.1.tar.gz (20.6 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: vimgolf-0.5.1.tar.gz
  • Upload date:
  • Size: 20.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for vimgolf-0.5.1.tar.gz
Algorithm Hash digest
SHA256 8e41abf7a694ed520958bb12d99b78652babeda34290e17492307fb6410b3f65
MD5 00c39cd232542127b3f9cd7fb3dbcf71
BLAKE2b-256 af80dbffc921c18897d60fb50dd17144a3ffaaa9073b35d08210b5b98dd734ae

See more details on using hashes here.

File details

Details for the file vimgolf-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: vimgolf-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 18.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for vimgolf-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9dc2aeca4d424e5185ef3e6cb79524abbabad6ba8d8dc7fa777a88cf1b7c44d6
MD5 585296b028a6ec3ff449ccf24b80d9ef
BLAKE2b-256 2e8a2df1442d0566ebfdc1b45d3d268e161bf3c9a2e10481f70a14fdbd17e216

See more details on using hashes here.

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