Metadata-Version: 2.1
Name: wordly
Version: 0.0.2
Summary: A simple python client that requests dictionary definitions from a server that implements Dictionary Server Protocol
Author-email: Marko Marić <marko@lambdabread.io>
License: MIT License
        
        Copyright (c) 2024 Marko Marić
        
        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: repository, https://github.com/MarkoM-dot/wordly
Keywords: wordly,definition,dictionary,DICT
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: build
Requires-Dist: build; extra == "build"
Requires-Dist: twine; extra == "build"

# Wordly

A python client to communicate with servers implementing the
[Dictionary Server Protocol](https://datatracker.ietf.org/doc/html/rfc2229)

## Getting Started

```
pip install wordly
```

## Usage

Once installed you may use wordly from the command line:

```
$ wordly programming
"programming" wn "WordNet (r) 3.0 (2006)"
programming
    n 1: setting an order and time for planned events [syn:
         {scheduling}, {programming}, {programing}]
    2: creating a sequence of instructions to enable the computer to
       do something [syn: {programming}, {programing}, {computer
       programming}, {computer programing}]
.
```

Or you may import `Word` from `wordly` in your scripts.

```py
from wordly import Word

w = Word("curious")

print(w.definition)
```
