Metadata-Version: 2.1
Name: word-def
Version: 0.2.1
Summary: Get definition of words in any language
Author-email: Daniel Martins Antunes <danoan2008@gmail.com>
License: MIT License
        
        Copyright (c) 2024, Daniel Martins Antunes
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Documentation, https://github.com/danoan/word-def#readme
Project-URL: Issues, https://github.com/danoan/word-def
Project-URL: Source, https://github.com/danoan/word-def
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# Getting started with Word Definition

Get definition of words in any language.

The `word-def` package is an extensible library to get definition of words
in any language. It can be used either as a library or through a command-line interface (CLI).

## Installation

```bash
# As a library
pip install word-def

# As a CLI
pipx install word-def
```

### Plugins available

- [Collins Dictionary English](https://github.com/danoan/word-def-plugin-english-collins/)
- [Multi-language dictionary](https://github.com/danoan/word-def-plugin-multilanguage-chatgpt)


## Features

- `get-definition`
- `get-synonym`
- `get-pos-tag`
- `get-usage-examples`

## Examples

```bash
$ word-def 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
```

You may need to specify a plugin configuration file if the plugin
requires extra parameters (e.g. credentials to access an API). You
can register these parameters in a TOML file and pass it to `word-def`.

```toml
<!-- plugin-config.toml -->
["danoan.word_def.plugins.modules.english_collins"]
entrypoint = <ENTRYPOINT>
secret_key = <SECRET_KEY>
```

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

## Contributing

Please reference to our [contribution](http://danoan.github.io/word-def/contributing) and [code-of-conduct](http://danoan.github.io/word-def/code-of-conduct) guidelines.
