# Cambd
> [Cambridge dictionary](https://dictionary.cambridge.org) cli app
<img src="https://www.dropbox.com/s/1jydlxwzmj8e6po/demo.gif?raw=1" alt="cambd, Cambridge dictionary cli app" />
## Features
- Automatically suggests related words when a typo is detected.
- Provides an interactive suggestion menu for selecting the correct word in case of a typo.
- Supports past and past participle forms, returning the definition of the root word.
- Operates without relying on any external APIs or databases.
- Implements persistent caching to store previously searched words, ensuring faster results. The cache is maintained using Python's built-in `sqlite3`.
## Install
```sh
pip install cambd
```
## Usage
```sh
Usage: cambd [OPTIONS] WORD
Options:
-a, --show-all Show all the definitions of a word.
-d, --dictionary TEXT Determine which dictionary region to use (uk, us) [default: uk]
-v, --verbose Show extra word info ie, word codes & labels. [ex: A2 informal]
-c, --clear-cache Clear all the stored cache from system.
--version Show the version and exit.
--help Show this message and exit.
```
## FAQ
Q. Why scrape instead of using a Dictionary API?
> [!NOTE]
> TBH, As a non native english speaker, I find the cambridge dictionary the most easy to understand. But they don't have any public free API with all the features I want like getting suggestions on misspelled words and give both US and UK definations etc. So I ended up building this cli tool with basic scrapping for my own usecase as I am a terminal power user and don't want to leave the terminal, go to browser, open a new tab just to search for a word meaning.
## LICENSE
[MIT](./LICENSE) License © [Rocktim Saikia](https://rocktimsaikia.dev) 2024
Raw data
{
"_id": null,
"home_page": "https://github.com/rocktimsaikia/cambd",
"name": "cambd",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Rocktim Saikia",
"author_email": "saikia.rocktim@proton.me",
"download_url": "https://files.pythonhosted.org/packages/27/88/4e5e38be13dab1f710aaff27c78fab9a81486739124556192a0766757620/cambd-1.0.2.tar.gz",
"platform": null,
"description": "# Cambd\n\n> [Cambridge dictionary](https://dictionary.cambridge.org) cli app\n\n<img src=\"https://www.dropbox.com/s/1jydlxwzmj8e6po/demo.gif?raw=1\" alt=\"cambd, Cambridge dictionary cli app\" />\n\n## Features\n\n- Automatically suggests related words when a typo is detected.\n- Provides an interactive suggestion menu for selecting the correct word in case of a typo.\n- Supports past and past participle forms, returning the definition of the root word.\n- Operates without relying on any external APIs or databases.\n- Implements persistent caching to store previously searched words, ensuring faster results. The cache is maintained using Python's built-in `sqlite3`.\n\n## Install\n\n```sh\npip install cambd\n```\n\n## Usage\n\n```sh\nUsage: cambd [OPTIONS] WORD\n\nOptions:\n -a, --show-all Show all the definitions of a word.\n -d, --dictionary TEXT Determine which dictionary region to use (uk, us) [default: uk]\n -v, --verbose Show extra word info ie, word codes & labels. [ex: A2 informal]\n -c, --clear-cache Clear all the stored cache from system.\n --version Show the version and exit.\n --help Show this message and exit.\n```\n\n## FAQ\n\nQ. Why scrape instead of using a Dictionary API?\n\n> [!NOTE]\n> TBH, As a non native english speaker, I find the cambridge dictionary the most easy to understand. But they don't have any public free API with all the features I want like getting suggestions on misspelled words and give both US and UK definations etc. So I ended up building this cli tool with basic scrapping for my own usecase as I am a terminal power user and don't want to leave the terminal, go to browser, open a new tab just to search for a word meaning.\n\n## LICENSE\n\n[MIT](./LICENSE) License © [Rocktim Saikia](https://rocktimsaikia.dev) 2024\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Cambridge dictionary cli app",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/rocktimsaikia/cambd"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c335691371655cfac06e31cd210bb553fe7acab08006a367862e6a63b7bc5a3d",
"md5": "dd944126eb6b4229db84331d417aa5be",
"sha256": "2204a54c1fa2a6c06c6baeaa33cc73f0bb9b2514eb82d7ea2b187e7a31090533"
},
"downloads": -1,
"filename": "cambd-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dd944126eb6b4229db84331d417aa5be",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7033,
"upload_time": "2024-08-30T19:52:06",
"upload_time_iso_8601": "2024-08-30T19:52:06.708855Z",
"url": "https://files.pythonhosted.org/packages/c3/35/691371655cfac06e31cd210bb553fe7acab08006a367862e6a63b7bc5a3d/cambd-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "27884e5e38be13dab1f710aaff27c78fab9a81486739124556192a0766757620",
"md5": "854df98ca5ed46dd73c2e376e501f9f3",
"sha256": "5ef44ab6935a7e652d13cf09cec96bbc558e3e2bb6a1b741ce6b68931d1f4d9c"
},
"downloads": -1,
"filename": "cambd-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "854df98ca5ed46dd73c2e376e501f9f3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6255,
"upload_time": "2024-08-30T19:52:08",
"upload_time_iso_8601": "2024-08-30T19:52:08.246750Z",
"url": "https://files.pythonhosted.org/packages/27/88/4e5e38be13dab1f710aaff27c78fab9a81486739124556192a0766757620/cambd-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-30 19:52:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rocktimsaikia",
"github_project": "cambd",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "cambd"
}
JSON
