Skip to main content

A command line dictionary toolset.

Project description

cmdict · pypi GitHub license CI codecov poetry black

cmdict not only is an English-to-Chinese dictionary application with a command-line interface, but also provide out-of-box features like extracting highlighted words from a PDF file. It runs on Linux, macOS, and Windows. Additionally, it can be used as a Python package.

How to install

The easiest way is to use Homebrew:

brew install pastydev/cmdict/cmdict

To install it from PyPI:

pip install cmdict

How to use

$ cmdict --help
Usage: cmdict [OPTIONS] COMMAND [ARGS]...

  Command line interface.

Options:
  --help  Show this message and exit.

Commands:
  download  Download necessary database before using cmdict.
  extract   Extract highlighted words with specified color in a PDF file.
  scan      Scan all words in a txt file and return search results.
  search    Type in one English word and echo its Chinese translation.

To echo Chinese translation for one or multiple English words.

$ cmdict search apple
--------
apple

    phonetic: 'æpl
    definition:
        - n. fruit with red or yellow or green skin and sweet to tart crisp whitish flesh
        - n. native Eurasian tree widely cultivated in many varieties for its firm rounded edible fruits
    trans:
        - n. 苹果, 家伙
        - [医] 苹果
    collins: 3
    oxford: 1
    bnc: 2446
    frq: 2695
$ cmdict search apple banana

To extract highlighted words in blue of sample.pdf:

$ cmdict extract sample.pdf --color blue
--------
apple

    phonetic: 'æpl
    definition:
        - n. fruit with red or yellow or green skin and sweet to tart crisp whitish flesh
        - n. native Eurasian tree widely cultivated in many varieties for its firm rounded edible fruits
    trans:
        - n. 苹果, 家伙
        - [医] 苹果
    collins: 3
    oxford: 1
    bnc: 2446
    frq: 2695

Data support

  • skywind3000/ECDICT: a free English to Chinese dictionary database (英中双解词典数据库).
$ cmdict download
--------
Downloading the dictionary...
100%|████████████████████████| 217M/217M [00:29<00:00, 666MiB/s]

cmdict is ready to use!

How to contribute

Open in GitHub Codespaces

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

cmdict-0.1.10.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

cmdict-0.1.10-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file cmdict-0.1.10.tar.gz.

File metadata

  • Download URL: cmdict-0.1.10.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for cmdict-0.1.10.tar.gz
Algorithm Hash digest
SHA256 a2baa8e2c34385daa4e124ca7ad6e354fce0c8d22bdb6ef7c24043cfb48262d4
MD5 968a24e734dfb7150d15d0b60c0de333
BLAKE2b-256 27347f074833d4c4b401cc4934fd8995b1ae69cc331ae4e65c7f43d2afc3d268

See more details on using hashes here.

File details

Details for the file cmdict-0.1.10-py3-none-any.whl.

File metadata

  • Download URL: cmdict-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 11.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for cmdict-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 5089220b4dbea5a42bdb6239f549bf7d1caab93b26df99449034b7ac45f7df36
MD5 7f7c902f38261169d49b7762a00105d9
BLAKE2b-256 697fe25a3daa39759d07986e8fdd2c089a41b6aeeadaa2b78c5e7ab5821b4b88

See more details on using hashes here.

Supported by

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