Skip to main content

A dictionary program for nix* terminals

Project description


A dictionary program for nix* terminals


Simply use pip to install the latest stable version -

$ pip install wordpy


Getting API keys

This package wouldn't be possible without the existence of Oxford Dictionaries. However, service hosting is costly and they must make some money themselves so they only let a simple, developer option for their prolix API. Register for it here.

When you first use wordpy, you'll recieve a prompt to enter your recently acquired credentials and store it for future usage. Don't worry, everything remains on your local system.

The program is extremely simple - you literally just get the definition of a word in your terminal. Or the synonyms if you're feeling adventurous.

$ wordpy <word>

To get synonyms -

$ wordpy -s <word>


$ wordpy apple
[s] Apple (noun)
The round fruit of a tree of the rose family, which typically has thin green or red skin and crisp flesh.
$ wordpy -s car 
[s] Car (noun)
A road vehicle, typically with four wheels, powered by an internal combustion engine and able to carry a small number of people
[s] Synonyms
auto, automobile, bus, convertible, jeep, limousine, machine, motor, pickup, ride, station wagon, truck, van, wagon, bucket, buggy, compact, conveyance, coupe, hardtop, hatchback, heap, jalopy, junker, motorcar, roadster, sedan, subcompact, wheels, wreck, clunker, gas guzzler, touring car



Make an issue if you stumble upon a bug. Any ideas or features you'd like to be added, once again, make an issue out of.

To do something more simulating like writing code, just clone this repo, get it on your local system, make a branch, push it back to your master and finally, make a pull request.

I follow PEP-8 so you have to follow it too. Don't see why that's not already baked into the syntax.


To run tests, simply install nose -

$ pip install nose
$ python test

or run nosetests for a cleaner output -

$ nosetests

I've never been a big fan of testing... let me rephrase, I've never been a big fan of writing tests myself but there's a handful of them in tests/ that should succeed before you even think about committing.

Any new feature should come with its own test_<name_of_feature>.py file in the said tests/ directory and should be verbose with at least two cases.

Features To Add

  • Basic usage
  • Testing
  • Optimization
  • Documentation (?)
  • Even more features
    • [x] antonyms
    • [x] etymologies
    • [ ] different definitions

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wordpy-1.1.1.tar.gz (6.3 kB view hashes)

Uploaded source

Built Distribution

wordpy-1.1.1-py3-none-any.whl (9.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page