Skip to main content

A dictionary program for nix* terminals

Project description

wordpy

A dictionary program for nix* terminals

Installation

Simply use pip to install the latest stable version -

$ pip install wordpy

To get the bleeding edge version -

pip install git+https://github.com/mentix02/wordpy.git

Requirements

wordpy is available for all Unix and Unix-like operating systems. It supports Python 3.6 and above.

Usage

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, antonyms or even the origin i.e. etymology of the word if you're feeling adventurous.

Flags

Flag Usage
-s, --synonyms display synonyms
-a, --antonyms display antonyms
-e, --etymology show etymology
-v, --version display version
-h, --help show help message

Commands

$ wordpy <word>

To get synonyms -

$ wordpy -s <word>

Antonyms can be derived by -

$ wordpy -a <word>

And finally, etymology -

$ wordpy -e <word>

These flags can be combined to get whatever the user asks for. For example to get the definition, antonyms and the etymology, you can use -

$ wordpy -ae <word>

Examples

$ 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 # synonyms
[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
$ wordpy -as happy # antonyms and synonyms
[s] Happy (adjective)
Feeling or showing pleasure or contentment
[s] Synonyms
cheerful, contented, delighted, ecstatic, elated, glad, joyful, joyous, jubilant, lively, merry, overjoyed, peaceful, pleasant, pleased, thrilled, upbeat, blessed, blest, blissful, blithe, can't complain, captivated, chipper, chirpy, content, convivial, exultant, flying high, gay, gleeful, gratified, intoxicated, jolly, laughing, light, looking good, mirthful, on cloud nine, peppy, perky, playful, sparkling, sunny, tickled, tickled pink, up, walking on air
[s] Antonyms
depressed, disappointed, disturbed, down, grave, melancholy, miserable, sad, serious, sorrowful, troubled, unfriendly, unhappy, upset, discouraged, dissatisfied, forsaken, hopeless, morose, pained, unfortunate, unlucky
$ wordpy -e computer
[s] Computer (noun)
An electronic device for storing and processing data, typically in binary form, according to instructions given to it in a variable program.
[s] Etymology
1640s, "one who calculates," agent noun from compute (v.). Meaning "calculating machine" (of any type) is from 1897; in modern use, "programmable digital electronic computer" (1945 under this name; theoretical from 1937, as Turing machine). ENIAC (1946) usually is considered the first. Computer literacy is recorded from 1970; an attempt to establish computerate (adjective, on model of literate) in this sense in the early 1980s didn't catch on. Computerese "the jargon of programmers" is from 1960, as are computerize and computerization.

Development

Contributing

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.

Testing

To run tests, simply install nose -

$ pip install nose
$ python setup.py 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.2.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

wordpy-1.1.2-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file wordpy-1.1.2.tar.gz.

File metadata

  • Download URL: wordpy-1.1.2.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.7.2 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.6.7

File hashes

Hashes for wordpy-1.1.2.tar.gz
Algorithm Hash digest
SHA256 4d7b769e7128cba23a672324d45416483bb15250e35799713a9012e81a955785
MD5 431ad705ecb5408f4b7fc36ae058f80d
BLAKE2b-256 1abfc2fabb891865755bbd6c2bb9726e4c5b4768f2cd613c9cf8e1373a9132d6

See more details on using hashes here.

File details

Details for the file wordpy-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: wordpy-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 10.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.7.2 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.6.7

File hashes

Hashes for wordpy-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ffbbb0b6288b4902c536f466bd63e77fd6fca5e10044aabb851ff37b225ec56d
MD5 e6565f622ced61dee73ba942e8aff99d
BLAKE2b-256 fbd4e217cb98eb8686d1d3ba145342cc9231bb680fdd27d74e30a58aa2e0f979

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page