Skip to main content

YAML dictionary support for Plover.

Project description

YAML dictionary support for Plover.


Download the latest version of Plover for your operating system from the releases page. Only versions 4.0.0.dev1 and higher are supported.

  1. Open Plover
  2. Navigate to the Plugin Manager tool
  3. Select the “plover-yaml-dictionary” plugin entry in the list
  4. Click install
  5. Restart Plover

The same method can be used for updating and uninstalling the plugin.

Dictionary Format

The YAML dictionary format used by this plugin maps translations to strokes rather than strokes to translations which differs from the default JSON dictionary format used by Plover. For a basic comparison,


"PHRO*EFR": "Plover",
"PHRO*FR": "plover",
"PHROFR": "Plover",



Comments manually added within the YAML dictionary file are currently not preserved due to performance limitations of the YAML package being used.

Converting JSON dictionaries to YAML

You can use the following script to take an input JSON dictionary file path and output YAML dictionary file path to convert existing Plover JSON dictionaries to the YAML format used by this plugin.

import json

import ruamel.yaml


# Load JSON dictionary
with open(JSON_FILENAME, 'r', encoding='utf-8') as in_file:
    in_data = json.load(in_file)

# Group dictionary by value, sorted alphabetically
out_data = {}

for key, value in sorted(in_data.items(), key=lambda x: x[1].casefold()):
    out_data.setdefault(value, []).append(key)
    out_data[value] = sorted(out_data[value])

# Write dictionary to YAML
with open(YAML_FILENAME, 'w', encoding='utf-8') as out_file:
    yaml = ruamel.yaml.YAML(typ='safe')
    yaml.allow_unicode = True
    yaml.default_flow_style = False
    yaml.indent(sequence=4, offset=2)
    yaml.dump(out_data, out_file)

Project details

Release history Release notifications

This version


Download files

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

Files for plover-yaml-dictionary, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size plover_yaml_dictionary-0.0.1-py3-none-any.whl (6.0 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size plover_yaml_dictionary-0.0.1.tar.gz (17.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page