Getting started with word-def Plugin English Collins

Plugin to word-def package that connects with the English Collins dictionary API.

Installation

$ pipx install word-def-plugin-english-collins

Features

  • Get word definition.

  • Get part-of-speech tags of a word.

Examples

word-def

You need to have the word-def package installed.

$ word-def --plugin-configuration-filepath plugin-config.toml get-definition joy eng

1. a deep feeling or condition of happiness or contentment
2. something causing such a feeling; a source of happiness
3. an outward show of pleasure or delight; rejoicing
4. success; satisfaction
5. to make joyful; gladden

Plugin configuration

The word-def documentation has more information about how to setup the plugin configuration file.

Plugin parameters

To configure the plugin, create the plugin-config.toml file similar to the one below:

entrypoint="COLLINS API URL"
secret_key="PERSONAL SECRET KEY"

Contributing

Please reference to our contribution and code-of-conduct guidelines.