Add emacs-paw pip

Author: chenyanming

Makefile

@@ -0,0 +1,9 @@
+.PHONY: clean
+clean:
+	rm -rf build dist *.egg-info
+.PHONY: dist
+dist: clean
+	python3 -m build
+.PHONY: upload
+upload: dist
+	python3 -m twine upload dist/*

README.org

@@ -120,7 +120,7 @@ You should install the following Dependencies if you want to make use all the po
   - [[https://github.com/rany2/edge-tts/][edge-tts]] (pronunciation)
   - [[https://github.com/ikawaha/kagome][kagome]] (For Japanese segmentation)
 
-- python dependencies (install under the repo root folder by ~pip install .~ or one by one manually):
+- python dependencies (install under the repo root folder by ~pip install emacs-paw~ or one by one manually):
   - Python itself (3.10+, for mac 3.11+)
   - nltk
   - flask
@@ -168,9 +168,9 @@ Five steps:
         brew install python # You can use pyenv or other tools to install python
         #+end_src
 
-3. Clone this repo to any place, and install ~paw~ command line by the following command, but this is optional, it helps you setup the dependencies
+3. Install ~paw~ command line by the following command
         #+begin_src sh
-        pip install .
+        pip install emacs-paw
         #+end_src
 
 4-1. Please be patient... run the following command lines, you may need to adjust them based on your system, take mac for example:
@@ -181,13 +181,13 @@ Five steps:
         # Language Detection
         pip install pycld2 # install gcld3 on mac is difficult...
         # English
-        pip install nltk # not needed if install by pip install .
+        pip install nltk # not needed if install by pip install emacs-paw
         python -m nltk.downloader stopwords
         python -m nltk.downloader punkt
         # Japanese
-        pip install mecab-python3 unidic-lite # not needed if install by pip install .
+        pip install mecab-python3 unidic-lite # not needed if install by pip install emacs-paw
         # paw-server, for mac, please install python 3.11, 3.10 may have segementation fault issue
-        pip install flask flask-cors requests # not needed if install by pip install .
+        pip install flask flask-cors requests # not needed if install by pip install emacs-paw
         #+end_src
 
 4-2. For android install:
@@ -197,7 +197,7 @@ Five steps:
         apt update
         apt install protobuf
         pip3.10 install gcld3 
-        pip3.10 install flask flask-cors requests # not needed if install by pip install .
+        pip3.10 install flask flask-cors requests # not needed if install by pip install emacs-paw
         #+end_src
 
 5. Finally, Install paw.el

README_PAW_CLI.md

@@ -0,0 +1,40 @@
+# 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.
+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/ --port 5001 --wallabag-host https://example.com --wallabag-username username --wallabag-password password --wallabag-clientid clientid --wallabag-secret secret
+```
+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
+```
+## Author
+Damon Chan
+## License
+This project is licensed under the GNU General Public License v3.0.

pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+[project]
+name = "emacs-paw"
+version = "0.1.2"
+description = "Study for a life in Emacs with advanced annotation and language learning tools."
+readme = "README_PAW_CLI.md"
+authors = [{ name = "Damon Chan" }]
+license = { file = "LICENSE" }
+keywords = ["Emacs", "annotation", "language learning", "dictionary", "sql", "org-mode"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Natural Language :: English",
+    "Natural Language :: Japanese",
+    "Operating System :: OS Independent"
+]
+requires-python = ">=3.10"
+dependencies = [
+    "Flask",
+    "flask-cors",
+    "requests",
+    "nltk",
+    "mecab-python3",
+    "unidic-lite"
+]
+[project.urls]
+Homepage = "https://github.com/chenyanming/paw"
+Repository = "https://github.com/chenyanming/paw"
+[project.scripts]
+paw = "paw.cli:main"
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["paw"]