# paw (point-and-write)
`emacs-paw` is a command line tool work with [paw.el](https://github.com/chenyanming/paw).
## Dependencies and Installation
### Python Dependencies
Install emacs-paw
```sh
pip install emacs-paw
```
Install:
```sh
python -m nltk.downloader stopwords
python -m nltk.downloader punkt
```
## Usage
### Command Line Interface
The `paw` command line tool is designed to work with `paw.el`, providing several commands to facilitate the setup and operation of the Emacs plugin. The available commands are:
- `run_server`: Start the PAW server for handling annotation requests.
- `en_search`: Search in English dictionaries.
- `ja_search`: Search in Japanese dictionaries.
- `ja_sgment`: Search in Japanese segmentation.
Refer to `cli.py` for more details on these commands.
### Example Usage
2. Start the PAW server:
```sh
paw run_server --database /home/damonchan/org/paw.sqlite --save-dir /tmp/source.html --port 5001 --wallabag-host https://example.com --wallabag-username username --wallabag-password password --wallabag-clientid clientid --wallabag-secret secret
```
- `--save-dir`: The directory to save the html or the file name of the html file.
3. Perform an English search:
```sh
paw en_search /home/damonchan/org/stardict.db MATCH hello --tag "" --wordlists /home/damonchan/org/5000.csv --known-words-files /home/damonchan/org/eudic.csv,/home/damonchan/org/english.txt
```
4. Perform a Japanese search:
```sh
paw ja_search /home/damonchan/org/japanese.db MATCH 海外の大企業は「ダイバーシティ(多様性)&インクルージョン(包括的) --tag "" --wordlist /home/damonchan/org/蓝宝书日语文法.csv --known-words-files /home/damonchan/org/japanese.txt
```
5. Perform a Japanese Segemtation:
```
paw ja_segment すもももももももものうち
すもも も もも も もも の うち
```
6. Check language
```
paw check_language --language "english,chinese,japanese" --text "これは日本語の文です"
```
## Author
Damon Chan
## License
This project is licensed under the GNU General Public License v3.0.
Raw data
{
"_id": null,
"home_page": null,
"name": "emacs-paw",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "Emacs, annotation, language learning, dictionary, sql, org-mode",
"author": "Damon Chan",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d4/39/967bb892d55a2b4e85a00d0803d04c08b046817bc0477db3cc0e87cd1d02/emacs_paw-0.1.10.tar.gz",
"platform": null,
"description": "# paw (point-and-write)\n`emacs-paw` is a command line tool work with [paw.el](https://github.com/chenyanming/paw).\n\n## Dependencies and Installation\n### Python Dependencies\nInstall emacs-paw\n```sh\npip install emacs-paw\n```\n\nInstall:\n```sh\npython -m nltk.downloader stopwords\npython -m nltk.downloader punkt\n```\n\n## Usage\n### Command Line Interface\nThe `paw` command line tool is designed to work with `paw.el`, providing several commands to facilitate the setup and operation of the Emacs plugin. The available commands are:\n- `run_server`: Start the PAW server for handling annotation requests.\n- `en_search`: Search in English dictionaries.\n- `ja_search`: Search in Japanese dictionaries.\n- `ja_sgment`: Search in Japanese segmentation.\nRefer to `cli.py` for more details on these commands.\n### Example Usage\n2. Start the PAW server:\n```sh\npaw run_server --database /home/damonchan/org/paw.sqlite --save-dir /tmp/source.html --port 5001 --wallabag-host https://example.com --wallabag-username username --wallabag-password password --wallabag-clientid clientid --wallabag-secret secret\n```\n- `--save-dir`: The directory to save the html or the file name of the html file.\n\n3. Perform an English search:\n```sh\npaw en_search /home/damonchan/org/stardict.db MATCH hello --tag \"\" --wordlists /home/damonchan/org/5000.csv --known-words-files /home/damonchan/org/eudic.csv,/home/damonchan/org/english.txt\n```\n4. Perform a Japanese search:\n```sh\npaw ja_search /home/damonchan/org/japanese.db MATCH \u6d77\u5916\u306e\u5927\u4f01\u696d\u306f\u300c\u30c0\u30a4\u30d0\u30fc\u30b7\u30c6\u30a3\uff08\u591a\u69d8\u6027\uff09\uff06\u30a4\u30f3\u30af\u30eb\u30fc\u30b8\u30e7\u30f3\uff08\u5305\u62ec\u7684\uff09 --tag \"\" --wordlist /home/damonchan/org/\u84dd\u5b9d\u4e66\u65e5\u8bed\u6587\u6cd5.csv --known-words-files /home/damonchan/org/japanese.txt\n```\n5. Perform a Japanese Segemtation:\n```\npaw ja_segment \u3059\u3082\u3082\u3082\u3082\u3082\u3082\u3082\u3082\u306e\u3046\u3061\n\u3059\u3082\u3082 \u3082 \u3082\u3082 \u3082 \u3082\u3082 \u306e \u3046\u3061\n```\n6. Check language\n```\npaw check_language --language \"english,chinese,japanese\" --text \"\u3053\u308c\u306f\u65e5\u672c\u8a9e\u306e\u6587\u3067\u3059\"\n```\n## Author\nDamon Chan\n## License\nThis project is licensed under the GNU General Public License v3.0.\n",
"bugtrack_url": null,
"license": null,
"summary": "Study for a life in Emacs with advanced annotation and language learning tools.",
"version": "0.1.10",
"project_urls": {
"Homepage": "https://github.com/chenyanming/paw",
"Repository": "https://github.com/chenyanming/paw"
},
"split_keywords": [
"emacs",
" annotation",
" language learning",
" dictionary",
" sql",
" org-mode"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1c39a29f9d6f29669ac3e006f9fad84e3c3532b8e094a1100a7fb6441c849518",
"md5": "63b3cedfce2b5f642f593e15815a81d7",
"sha256": "57b5669a9a312ead8f8ed4f6c2a04f85157245607349271412925a00cae6e2eb"
},
"downloads": -1,
"filename": "emacs_paw-0.1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "63b3cedfce2b5f642f593e15815a81d7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 27541,
"upload_time": "2025-07-28T14:40:19",
"upload_time_iso_8601": "2025-07-28T14:40:19.389893Z",
"url": "https://files.pythonhosted.org/packages/1c/39/a29f9d6f29669ac3e006f9fad84e3c3532b8e094a1100a7fb6441c849518/emacs_paw-0.1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d439967bb892d55a2b4e85a00d0803d04c08b046817bc0477db3cc0e87cd1d02",
"md5": "04874621b50405d6a80067731dc2984e",
"sha256": "15f883944e3f2a000408c5ae383545066bbbe59fcb9328dcc9a1d93c851bfffb"
},
"downloads": -1,
"filename": "emacs_paw-0.1.10.tar.gz",
"has_sig": false,
"md5_digest": "04874621b50405d6a80067731dc2984e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 24964,
"upload_time": "2025-07-28T14:40:20",
"upload_time_iso_8601": "2025-07-28T14:40:20.574585Z",
"url": "https://files.pythonhosted.org/packages/d4/39/967bb892d55a2b4e85a00d0803d04c08b046817bc0477db3cc0e87cd1d02/emacs_paw-0.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-28 14:40:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chenyanming",
"github_project": "paw",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "emacs-paw"
}