sethdusek / define Goto Github PK

View Code? Open in Web Editor NEW

27.0 5.0 2.0 297 KB

Terminal dictionary

License: BSD 2-Clause "Simplified" License

Python 92.77% Roff 7.23%

define's Introduction

Define

Define is a terminal dictionary script that uses wordnik for definitions. Supports audio pronunciation

Example:

$define love

LOVE:

A deep, tender, ineffable feeling of affection and solicitude toward a person, such as that arising from kinship, recognition of attractive qualities, or a sense of underlying oneness.

INSTALLATION

Installing define is easy:

Using pip:

$ sudo pip install define

On Arch:

$ yaourt -S define

Manual Installation:

$ sudo python setup.py install ~~You will need an api key from wordnik, get one from developer.wordnik.com and edit the "key" variable inside the script~~ API key is now included in the script

Notes for Ubuntu 15.04 (may apply to other versions): To enable pip you'll need to add universe to your sources.

$ echo "deb http://archive.ubuntu.com/ubuntu/ vivid universe" | sudo tee -a "/etc/apt/sources.list"

$ sudo apt-get update

$ sudo apt-get install python-pip

To make use of audio feature if you install with pip. You'll need to install the gstreamer pacakge.

$ sudo apt-get install gstreamer1.0-tools

Using Audio

Audio can be used in define with the -a or --audio flag.

$ define --audio love

LOVE:

A deep, tender, ineffable feeling of affection and solicitude toward
a person, such as that arising from kinship, recognition of
attractive qualities, or a sense of underlying oneness.

Would you like to hear audio pronunciation? [Y/N] n

FLAGS

Define has the following flags:

-h/--help - Display help and exit.

-a/--audio - Audio pronunciation of keyword.

-t/--thesaurus - Thesaurus results for keyword.

-u/--urban - Search Urban Dictionary for results instead of Wordnik.

-l/--local - Search keywords using local dict and dictd dictionary (NOTE: This currently only works with the gcide dictionary, no other dictionary will work at the moment)

define's People

Contributors

Stargazers

Watchers

Forkers

coldsauce radek-sprta

define's Issues

HTTP use causes privacy issues

This software, needlessly, uses a website to define words. This is a privacy issue, for many obvious reasons. The first of which is a simple MITM attack, and the worst of which is data collected by the service used itself. There are, at least, access logs containing the users' IP addresses, and SethDusek5, himself, says that stats are collected on the words users define.

This also brings up issues where this project is wasting bandwidth, making HTTP requests when you could obviously just look for the definition in a file easily.

Way sound is being played is not compatible with every system.

I know this has been referenced in a previous issue: #5 however, the fix was add a dependency to an Arch package. For people installing this from source or people using operating systems where play is not available, that isn't an adequate fix.

Getting sound to work on every platform is a nightmare (I just tried :D ) I guess that's why libraries exist..

Here's a good page that lists a few external dependencies we could use to play sounds programatically.

https://wiki.python.org/moin/PythonInMusic

name conflict with existing program

Hiya, trying to (well I did lol) package this for aur. Can see it here https://aur.archlinux.org/packages/whatis-git/

But it seems to conflict with any existing package that ALOT of people most likely have installed. (whatis from man-db package)

https://www.archlinux.org/packages/core/i686/man-db/files/

Is there any other names you would consider being ok to use for the "executable" name?

HTTP issues, that are real and need to be addressed rather than ignored

Hi, I've already opened 3 issues but am not satisfied, even though define supports local wordnet and also gcide for the dict protocol.

The program prints an error when no definition is found

The program prints out this error when the searched string has not been found on Wordnik.

Traceback (most recent call last):
  File "/usr/bin/define", line 24, in <module>
    print(rem[i].upper() + ": \n" + client.getDefinitions(rem[i])[0].text)
TypeError: 'NoneType' object has no attribute '__getitem__'

Audio does not work

I get this error whilst using the --audio flag:

bash: play: command not found

I suggest using mplayer, which can fetch the audio file by itself without the need of wget.
If mplayer is out of the question, fix the package dependencies.

HTTP issues

This issue is, actually, #16 , #22 and #23 but they were closed by the childish maintainer of this project. No need to add a proper description, just read those, other than #23 which was changed by the aforementioned childish maintainer.

API Keys

Your current code has API keys for services used, you should either remove all such items and services. This application is infringing on the rights of users. People want to be able to freely look up a term in a dictionary of their language. The best way to do this is to use the dictionaries already present on the system.

Do not use services that log requests made by users, and, certainly, not with your API keys. Your users are not you.

Language

In this code, it is assumed that the user wants the English definition. Perhaps this could be fixed by using the system dictionary?

Support for multiple definitions

Almost all words are not limited to one definition. And usually the Wordnik web-interface shows a few of them alongside with the corresponding part of speech. It would be nice for this program to do the same.