Package: worddfn
Search for definition with example, verbs, synonyms and antonyms of a given word.About wordDFNworddfn is a wordnik API CLI client that uses thewordnikAPI to retrieve data about a single word and parse it into the cli (terminal) for the user.RequirementsNoteworddfn has not been tested on Mac and Windows at the moment, but should be able to function properly.OnMac, need to assure that thepbcopyandpbpastecommands are present.OnWindows, no additional modules are needed.SystemLinux:worddfn uses xclip, command line interface to X selections (clipboard). Make sure to have xclip install on your system.Install:sudo apt install xcliplinkalternative worddfn can use xsel to help handle the clipboard.Install:sudo apt install xselWordnik API key:For worddfn to function you will need a wordnik API key.To get an API key you will first need a wordnik accountSing UpYou can check out thepricing listTo learn more about wordnik check out the following links:About wordnik.Getting started with the wordnik API.Wordnik Docs.You can also check out theirgithub reposCAUTION!While this module (client) is release under the MIT License (see license) the API is not, wordnik have it's own TOS, i hereby acknowledge those TOS and ask of anyone who come to use this client to do the same. In the source code of this module there are a function that is use to cache data solely for the Purpose of readability (to beter manage the parsing of the data) and nothing else.For more information on the wordnik API TOSsee Wordnik API Terms of Service Agreement.How to useINSTALATIONbefore installing this module make sure you have yourAPI key.To Install run:pip3 install worddfn  

or  

python3 -m pip install worddfnUSAGEWhen first launch you will be prompted with the setting file where you'll need to enter your API key and save your setting.Copy a text (this need to be a word) into the clipboard, if the clipboard have multiple text worddfn will only use the first text (make sure you copy a single word you would like to learn about).Using the Clipboard:If a word is in the clipboard all you need to run from cli is:$ wordor$ python3 -m worddfnWithout make use of the Clipboard:When the clipboard contains no data you can run:$ word -hor$ python3 -m worddfn -hto obtain help.example:$ word -h  

usage: __main__.py [-h] [-f [VERB]] [-s [SYN]] [-o [ANT]] [word]  

positional arguments:  
  word  

options:  
  -h, --help            show this help message and exit  
  -f [VERB], --verb [VERB]  
  -s [SYN], --syn [SYN]  
  -o [ANT], --ant [ANT]To search for a word run$ word awordor$ python3 -m worddfn awordthis will return a number of definition (4 results by default) of the word obtain via the wordnik API, if the word looking for was found.example:$ word source  

.....  
word:source  
.....  
Attribution:from The American Heritage® Dictionary of the English Language, 5th Edition. (ahd-5)
Definition:A person or thing from which something comes into being or is derived or obtained.
Example:alternative sources of energy; the source of funding for the project.  

Attribution:from The American Heritage® Dictionary of the English Language, 5th Edition. (ahd-5)
Definition:The point of origin of a stream or river.
Example:A reporter is only as reliable as his or her sources.To search for verbs of the word use:$ word -f source  

.....  
verb:source  
.....  
Verb:  
sourced  
sources  
sourcingremember to check the-hor--helpoption for more details on using worddfn.General Usageif the word you wishes to get information on is source the basic wayof achiving this can be one of the following.To search for definitions use:$ word sourceTo search for verb form of a word use:$ word -f sourceTo search for the synonym of a word use:$ word -s sourceTo search for the antonym of a word use:$ word -o sourceINSTALL FROM SOURCEThis is not the recommended way to go about installing this module especially for inexperience python users who is only looking to use the module as a cli utility, while the steeps are generally easy to follow you may encounter with unexpected errors.The recommended waysare to install fromPyPIsee installation sectionor download thelatest build packagefrom therepo.System requirementsee.To Build this module first clone or download the repo.Make sure you have the latest version of PyPA’s build installed, run:python3 -m pip install --upgrade build`Change to wordDFN directory:cd /path/to/wordDFNNow run the following command from the same directory where pyproject.toml is located:python3 -m buildAfter the build is completed, it should generate two files in the dist directory, change to the dist directory and install the package, for that run:cd /path/to/wordDFN/dist
pip3 install worddfn-x.x.x-py3-none-any.whlCreditsThis project uses:wordnikAPI.pyperclipto help manage the clipboard seepyperclip repo.xclipas system dependency use by pyperclip.LicenseThis project is licensed under the terms of theMIT license.WORDNIK APIThis project also respects and acknowledge the TOS ofwordnik API.