https://github.com/dstein64/vimgolf

A vimgolf client written in Python.
https://github.com/dstein64/vimgolf

python vim vimgolf

Last synced: 18 days ago
JSON representation

A vimgolf client written in Python.

• Host: GitHub
• URL: https://github.com/dstein64/vimgolf
• Owner: dstein64
• License: mit
• Created: 2019-02-17T04:05:01.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-13T00:48:59.000Z (6 months ago)
• Last Synced: 2024-10-23T03:26:55.733Z (23 days ago)
• Topics: python, vim, vimgolf
• Language: Python
• Homepage: https://pypi.org/project/vimgolf/
• Size: 444 KB
• Stars: 25
• Watchers: 4
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://github.com/dstein64/vimgolf/workflows/build/badge.svg)](https://github.com/dstein64/vimgolf/actions)

vimgolf

=======

This project contains a [vimgolf](https://www.vimgolf.com/) client written in Python.

The user interface is similar to the [official vimgolf client](https://github.com/igrigorik/vimgolf),

with a few additions inspired by [vimgolf-finder](https://github.com/kciter/vimgolf-finder), and an

optional way to specify keys to type when launching a challenge.

Installation

------------

#### Requirements

- Python 3.6 or greater

#### Install

```sh

$ pip3 install vimgolf

```

#### Update

```sh

$ pip3 install --upgrade vimgolf

```

Usage

-----

#### Launch

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

directly.

```sh

$ vimgolf

```

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

```sh

$ python3 -m vimgolf

```

#### Commands

```text

  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` 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., ``) if that would be possible given the characters that follow. The input

string should use `` to disambiguate.

Demo




License

-------

The source code has an [MIT License](https://en.wikipedia.org/wiki/MIT_License).

See [LICENSE](https://github.com/dstein64/vimgolf/blob/master/LICENSE).