Metadata-Version: 2.4
Name: shabd
Version: 2.0
Summary: A command-line English dictionary tool
Home-page: https://github.com/spignelon/shabd
Author: Ujjawal Saini
Author-email: spignelon@proton.me
License: GPL-3.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Education
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: anyio==4.14.2
Requires-Dist: certifi==2026.7.22
Requires-Dist: h11==0.16.0
Requires-Dist: httpcore==1.0.9
Requires-Dist: httpx==0.28.1
Requires-Dist: idna==3.18
Requires-Dist: wn==1.1.1
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Shabd

A command-line English dictionary tool for quick word lookups.

## Features

- Lookup English word meanings directly from your terminal
- Works offline, with automatic background updates to its dictionary data
- Understands inflected forms automatically (e.g. `hike`, `hiking`, `hiked` all resolve to the same entry, irregular forms included)
- Simple and straightforward command-line interface

## Installation

You can install Shabd from PyPI:

```bash
pip install shabd
```

Or install directly from the repository:

```bash
git clone https://github.com/spignelon/shabd.git
cd shabd
pip install .
```

## Usage

Basic usage:

```bash
# Look up a single word
shabd apple

# Look up a phrase
shabd "machine learning"
```

Options:

```bash
# Display help
shabd --help

# Display version
shabd --version
```

## How It Works

Shabd uses the [Open English WordNet](https://github.com/globalwordnet/english-wordnet) (OEWN) via the [`wn`](https://github.com/goodmami/wn) library as its dictionary source. On first use it downloads the data (~11MB download, ~100MB once indexed locally) into `~/.wn_data`, then every lookup is served from there fully offline. It checks for a newer OEWN edition at most once every 30 days, never on every lookup.

**Note:** Shabd originally scraped [Cambridge Dictionary](https://dictionary.cambridge.org/), which worked for ~4 years, until Cambridge added Cloudflare bot-protection that blocks automated requests - so Shabd moved to this offline WordNet-based dictionary instead.

## License

This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.

## Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.

This project is the continuation of the [cambridge-dictionary](https://github.com/spignelon/cambridge-dictionary) project.
