arabcheck 0.1.0__py3-none-any.whl

arabcheck/__init__.py

@@ -0,0 +1,5 @@
+"""ArabCheck — Lightweight Arabic text toolkit."""
+from .core import ArabCheck
+
+__version__ = "0.2.0"
+__all__ = ["ArabCheck", "__version__"]

arabcheck/__main__.py

@@ -0,0 +1,5 @@
+import sys
+from .cli import main
+
+if __name__ == "__main__":
+    sys.exit(main())

arabcheck/cli.py

@@ -0,0 +1,59 @@
+"""واجهة سطر الأوامر."""
+from __future__ import annotations
+import argparse
+import json
+import sys
+from pathlib import Path
+from . import __version__
+from .core import ArabCheck
+
+
+def read_input(args, parser):
+    if args.file:
+        try:
+            return args.file.read_text(encoding="utf-8")
+        except FileNotFoundError:
+            parser.error(f"الملف غير موجود: {args.file}")
+    if args.text:
+        return args.text
+    if not sys.stdin.isatty():
+        return sys.stdin.read()
+    parser.error("لازم تمرّر نصاً، أو --file، أو stdin.")
+    return ""
+
+
+def build_parser():
+    p = argparse.ArgumentParser(prog="arabcheck", description="ArabCheck — تنظيف وفحص النصوص العربية.")
+    p.add_argument("text", nargs="?", help="النص")
+    p.add_argument("-f", "--file", type=Path, help="قراءة من ملف")
+    p.add_argument("-c", "--clean", action="store_true")
+    p.add_argument("-n", "--normalize", action="store_true")
+    p.add_argument("-a", "--audit", action="store_true")
+    p.add_argument("-j", "--json", action="store_true")
+    p.add_argument("-q", "--quiet", action="store_true")
+    p.add_argument("-V", "--version", action="version", version=f"%(prog)s {__version__}")
+    return p
+
+
+def main(argv=None) -> int:
+    parser = build_parser()
+    args = parser.parse_args(argv)
+    text = read_input(args, parser)
+    checker = ArabCheck()
+    result = checker.process(text, clean=args.clean, normalize=args.normalize, audit=args.audit)
+    if args.json:
+        payload = {**result, "meta": {
+            "cleaned": args.clean, "normalized": args.normalize,
+            "audited": args.audit, "version": __version__,
+        }}
+        print(json.dumps(payload, ensure_ascii=False, indent=2))
+    else:
+        if not args.quiet:
+            print(result["result"])
+        for issue in result["issues"]:
+            print(f"⚠️  {issue['message']}", file=sys.stderr)
+    return 1 if result["issues"] else 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

arabcheck/core.py

@@ -0,0 +1,49 @@
+"""النواة الرئيسية لـ ArabCheck."""
+from __future__ import annotations
+from .patterns import Patterns
+
+
+class ArabCheck:
+    def __init__(self) -> None:
+        self.patterns = Patterns()
+
+    def strip_tashkeel(self, text: str) -> str:
+        return self.patterns.TASHKEEL.sub("", text)
+
+    def strip_tatweel(self, text: str) -> str:
+        return self.patterns.TATWEEL.sub("", text)
+
+    def clean_text(self, text: str) -> str:
+        text = self.strip_tashkeel(text)
+        text = self.strip_tatweel(text)
+        return self.patterns.WHITESPACE.sub(" ", text).strip()
+
+    def normalize(self, text: str, *, taa_marbuta: bool = False) -> str:
+        text = self.patterns.ALIF_VARIANTS.sub("ا", text)
+        text = self.patterns.YAA_VARIANTS.sub("ي", text)
+        text = self.patterns.HAMZA_WAW.sub("و", text)
+        text = self.patterns.HAMZA_YAA.sub("ي", text)
+        if taa_marbuta:
+            text = self.patterns.TAA_MARBUTA.sub("ه", text)
+        return text
+
+    def audit(self, text: str) -> list:
+        issues = []
+        for i, word in enumerate(text.split(), start=1):
+            if self.patterns.HAMZAT_QAT.match(word):
+                issues.append({
+                    "type": "hamzat_qat",
+                    "word": word,
+                    "position": i,
+                    "message": f"احتمال خطأ: '{word}' تبدأ بـ 'ال' + همزة قطع.",
+                })
+        return issues
+
+    def process(self, text, *, clean=False, normalize=False, audit=False):
+        issues = self.audit(text) if audit else []
+        result = text
+        if normalize:
+            result = self.normalize(result)
+        if clean:
+            result = self.clean_text(result)
+        return {"input": text, "result": result, "issues": issues}

arabcheck/patterns.py

@@ -0,0 +1,27 @@
+"""أنماط regex المجمّعة مسبقاً."""
+from __future__ import annotations
+
+import re
+
+
+class Patterns:
+    """أنماط regex لأداء أفضل (compiled once)."""
+
+    # التشكيل: حركات + علامات قرآنية + ألف خنجرية
+    TASHKEEL = re.compile(
+        "[\u0610-\u061A\u064B-\u065F\u0670"
+        "\u06D6-\u06DC\u06DF-\u06E8\u06EA-\u06ED]"
+    )
+
+    TATWEEL = re.compile("\u0640")
+    WHITESPACE = re.compile(r"\s+")
+
+    # همزة قطع بعد "ال" التعريف
+    HAMZAT_QAT = re.compile(r"^ال[أإآ]")
+
+    # للتوحيد — كل واحد منفصل عشان يبقى واضح
+    ALIF_VARIANTS = re.compile(r"[إأآٱ]")
+    YAA_VARIANTS = re.compile(r"[ىي]")
+    TAA_MARBUTA = re.compile(r"ة")
+    HAMZA_WAW = re.compile(r"ؤ")
+    HAMZA_YAA = re.compile(r"ئ")

arabcheck-0.1.0.dist-info/METADATA

@@ -0,0 +1,247 @@
+Metadata-Version: 2.4
+Name: arabcheck
+Version: 0.1.0
+Summary: Lightweight toolkit and CLI for cleaning, normalizing, and auditing Arabic text.
+Author-email: Mohamed Kamal Salih Mahmod <102423366+MOHAMEDKAMALSALLIH@users.noreply.github.com>
+License: MIT
+Project-URL: Homepage, https://github.com/MOHAMEDKAMALSALLIH/arabcheck
+Project-URL: Repository, https://github.com/MOHAMEDKAMALSALLIH/arabcheck
+Project-URL: Issues, https://github.com/MOHAMEDKAMALSALLIH/arabcheck/issues
+Project-URL: Changelog, https://github.com/MOHAMEDKAMALSALLIH/arabcheck/blob/main/CHANGELOG.md
+Project-URL: Releases, https://github.com/MOHAMEDKAMALSALLIH/arabcheck/releases
+Keywords: arabic,nlp,text-cleaning,tashkeel
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: Arabic
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Dynamic: license-file
+
+# ArabCheck 🔍
+
+> A lightweight, open-source toolkit and CLI for cleaning, normalizing, and auditing Arabic text for AI and NLP workflows.
+
+![Python](https://img.shields.io/badge/python-3.8%2B-blue)
+![License](https://img.shields.io/badge/license-MIT-green)
+![Status](https://img.shields.io/badge/status-alpha-orange)
+
+---
+
+## Why ArabCheck?
+
+Arabic text data often contains noise that breaks NLP pipelines:
+
+- **Unicode variants** — `أ` / `إ` / `آ` / `ا` / `ٱ` all represent alif
+- **Diacritics (Tashkeel)** — fatha, damma, shadda, tanween
+- **Tatweel (Kashida)** — decorative stretching characters `ـــــ`
+- **Quranic marks** and extra whitespace
+
+ArabCheck makes cleaning and auditing this data a one-liner — with full transparency and configurable operations.
+
+---
+
+## Features
+
+- 🕌 **Tashkeel removal** — Harakat + Quranic marks
+- 🔤 **Character normalization** — Alif, Yaa, Hamza, Taa Marbuta
+- 〰️ **Tatweel removal** — Kashida stretching characters
+- 🧹 **Text cleaning** — Whitespace normalization
+- 🔍 **Grammar audit** — Detect common hamzat qat/wasl errors
+- 📂 **File + stdin support**
+- 🤖 **JSON output** for CI/CD pipelines
+- 🧩 **Extensible** — easy to add new rules
+
+---
+
+## Install
+
+```bash
+git clone https://github.com/MOHAMEDKAMALSALLIH/arabcheck.git
+cd arabcheck
+pip install -e .
+```
+
+Requirements: Python 3.8+ — no external dependencies.
+
+---
+
+Quick Start
+
+```bash
+arabcheck "النَّصُّ العَرَبِيُّ لِلتَّجْرِبَة" --clean
+```
+
+Input:
+
+```
+النَّصُّ العَرَبِيُّ لِلتَّجْرِبَة
+```
+
+Output:
+
+```
+النص العربي للتجربة
+```
+
+---
+
+Usage Examples
+
+1. Clean text
+
+```bash
+arabcheck "العَرَبِيَّةُ ـــ لُغَةٌ جَمِيلَةٌ" --clean
+# → العربية لغة جميلة
+```
+
+2. Normalize characters
+
+```bash
+arabcheck "أحمد إبراهيم آمن" --normalize
+# → احمد ابراهيم امن
+```
+
+⚠️ Warning: Normalization loses linguistic information. Use it for search, indexing, or NLP pipelines only.
+
+3. Audit text
+
+```bash
+arabcheck "الأمر بالأمر" --audit
+# ⚠️  احتمال خطأ: 'الأمر' تبدأ بـ 'ال' + همزة قطع.
+```
+
+4. JSON output (for automation)
+
+```bash
+arabcheck "النَّصُّ" --clean --json
+```
+
+```json
+{
+  "input": "النَّصُّ",
+  "result": "النص",
+  "issues": [],
+  "meta": {
+    "cleaned": true,
+    "normalized": false,
+    "audited": false,
+    "version": "0.1.0"
+  }
+}
+```
+
+5. Read from file
+
+```bash
+arabcheck --file dataset.txt --clean
+```
+
+6. From stdin
+
+```bash
+cat article.txt | arabcheck --clean
+```
+
+---
+
+CLI Reference
+
+```
+usage: arabcheck [-h] [-f FILE] [-c] [-n] [-a] [-j] [-q] [-V] [text]
+
+positional arguments:
+  text                  Text to process
+
+options:
+  -h, --help            Show help
+  -f, --file FILE       Read text from file
+  -c, --clean           Remove tashkeel, tatweel and extra whitespace
+  -n, --normalize       Normalize letters (alif, yaa, etc.)
+  -a, --audit           Audit common spelling issues
+  -j, --json            Output as JSON
+  -q, --quiet           Suppress text output
+  -V, --version         Show version
+```
+
+Exit Codes
+
+Code Meaning
+0 Success, no issues
+1 Issues found (with --audit)
+2 Input error
+
+---
+
+Use as a Library
+
+```python
+from arabcheck import ArabCheck
+
+checker = ArabCheck()
+
+# Clean
+text = checker.clean_text("النَّصُّ العَرَبِيُّ ـــ")
+print(text)  # → النص العربي
+
+# Normalize
+print(checker.normalize("أحمد إبراهيم"))
+# → احمد ابراهيم
+
+# Audit
+issues = checker.audit("الأمر بالأمر")
+for issue in issues:
+    print(issue["message"])
+```
+
+---
+
+Testing
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+---
+
+Roadmap
+
+☑ Tashkeel & Tatweel removal
+☑ Character normalization
+☑ File + stdin support
+☑ JSON output
+☑ Exit codes for CI/CD
+☑ Grammar audit (hamzat qat/wasl)
+☐ Extended audit rules
+☐ Dataset loading (CSV, JSONL)
+☐ Duplicate detection
+☐ Text quality statistics
+☐ Publish on PyPI
+
+---
+
+Contributing
+
+Contributions, issues, and feature requests are welcome! See CONTRIBUTING.md for guidelines.
+
+---
+
+Releases
+
+See Releases for version history.
+
+---
+
+License
+
+MIT — see LICENSE for details.
+
+---
+
+<p align="center">
+  Made with ❤️ for the Arabic NLP community
+</p>

arabcheck-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+arabcheck/__init__.py,sha256=k3WJRkPK83D3GeDH8_Fz1CLXDoRJ9Jplj82xWqKkTNc,143
+arabcheck/__main__.py,sha256=R8toRIEpaunLvLRpFhTKF4x0aBUmBLoqHo0IrF4wuTw,82
+arabcheck/cli.py,sha256=E-LY4gFpBzIaEeC2CnktrKlj06Yj1fYqPxmvqI-zqVA,2066
+arabcheck/core.py,sha256=Z5IRDPqd-1rdsjCa3JiBACa125XNDVE6kz4p0rq1zA0,1804
+arabcheck/patterns.py,sha256=BAEsf17cMsST8FiGx1WvjsPUVJwJH846rrUX6dcmFDg,833
+arabcheck-0.1.0.dist-info/licenses/LICENSE,sha256=Z0UBEKMkWFJy26jZ6lmBo47o-s7PD0_qbM0sdxWUsws,1077
+arabcheck-0.1.0.dist-info/METADATA,sha256=3n3-gTHf9lYiYZ7CJZEb1QS2KaLM9jMl4EjJO6Nsmk0,5423
+arabcheck-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+arabcheck-0.1.0.dist-info/entry_points.txt,sha256=SubV1UOG9_4s0SYJiqhB5BS08pMtM7em-hVXQ8hN9b4,49
+arabcheck-0.1.0.dist-info/top_level.txt,sha256=Eve9P2VpSSbULW8YxBF42OiN9OxkSXk5ntiJA45tEqA,10
+arabcheck-0.1.0.dist-info/RECORD,,

arabcheck-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

arabcheck-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+arabcheck = arabcheck.cli:main

arabcheck-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mohamed Kamal Sallih
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

arabcheck-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+arabcheck