Giter VIP home page Giter VIP logo

describe's Introduction

describe

query word definitions from Oxford Dictionaries API

Description

a small shell script for quickly looking up a words meaning, synonyms or antonyms from within the terminal.

⚠️ API Deprecation Warning

Oxford Dictionaries API version 1 will be deprecated on June 30, 2019 in favor of version 2. As a consequence you will have to update the script to version 2.0 as well as your accounts from Free to Prototype (unpaid) or Developer (paid) to continue using describe. Unfortunately, unpaid accounts won't be authorized to query for synonyms and antonyms anymore. You will still be able to fetch the definitions, though.

Installation

In order to make the script work you first have to register a (free) developer Prototype account at Oxford Dictionaries to obtain an app id and app key. In order to make --synonyms and --antonyms work you will have to update to the paid Developer plan.

Create a configuration file called ~/.config/describe and place your app id and app key in it like so:

app_id=<YOUR_APP_ID>
app_key=<YOUR_APP_KEY>

substituting <YOUR_APP_ID> with your real app id and <YOUR_APP_KEY> with your real app key.

Optionally, create a symlink to the script in a location contained in your path like /usr/bin or /usr/local/bin to make it conveniently executable from everywhere, e.g.

if you placed the script in /opt/scripts before:

sudo ln -s /opt/scripts/describe.sh /usr/local/bin/describe

Usage

To query for a words definition simply pass it as an argument to the script

$ describe tiny

tiny [ˈtʌɪni] is very small

Alternatively, you can try deriving the words meaning by its synonyms

$ describe --synonyms tiny

minute
small-scale
scaled-down
mini
baby
toy
pocket
fun-size
petite
dwarfish
knee-high
miniature
minuscule
microscopic
nanoscopic
infinitesimal
micro
diminutive
pocket-sized
reduced
Lilliputian

or its antonyms

$ describe --antonyms tiny

huge
significant

You can also obtain definitions for more than one word at once

$ describe tiny kitten

tiny [ˈtʌɪni] is very small
kitten [ˈkɪt(ə)n] is a young cat

Requirements

curl jq sed

describe's People

Contributors

migalvarez avatar tobiohlala avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.