dz-arabic-slug 0.1.0__tar.gz

dz_arabic_slug-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Oussama Boudinar <lionweb01@gmail.com>
+
+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.

dz_arabic_slug-0.1.0/PKG-INFO

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: dz-arabic-slug
+Version: 0.1.0
+Summary: Convert Arabic text into URL-friendly slugs with proper transliteration.
+Author-email: Oussama Boudinar <lionweb01@gmail.com>
+Maintainer-email: Oussama Boudinar <lionweb01@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/dzopensource-lab/dz-arabic-slug
+Project-URL: Repository, https://github.com/dzopensource-lab/dz-arabic-slug
+Project-URL: Issues, https://github.com/dzopensource-lab/dz-arabic-slug/issues
+Keywords: slug,arabic,slugify,url,transliteration,django,flask,fastapi
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Natural Language :: Arabic
+Classifier: Topic :: Text Processing :: Linguistic
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# dz-arabic-slug
+
+Convert Arabic text into clean, URL-friendly slugs with proper transliteration.
+
+[![Tests](https://github.com/dzopensource-lab/dz-arabic-slug/actions/workflows/test.yml/badge.svg)](https://github.com/dzopensource-lab/dz-arabic-slug/actions/workflows/test.yml)
+[![PyPI](https://img.shields.io/pypi/v/dz-arabic-slug.svg)](https://pypi.org/project/dz-arabic-slug/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+Fix the broken Arabic URLs problem in your Django, Flask, or FastAPI project - in one line of code.
+
+## The Problem
+
+Standard slug libraries fail with Arabic:
+
+    slugify("كيف تتعلم البرمجة")  # returns "" (empty!)
+
+This breaks SEO, user experience, and social sharing.
+
+## The Solution
+
+    from dz_arabic_slug import slugify
+    slugify("كيف تتعلم البرمجة")
+    # returns "kayf-tataealam-albarmaja"
+
+## Installation
+
+    pip install dz-arabic-slug
+
+## Quick Start
+
+### Django
+
+    from django.db import models
+    from dz_arabic_slug import slugify
+
+    class Article(models.Model):
+        title = models.CharField(max_length=200)
+        slug = models.SlugField(unique=True, blank=True)
+
+        def save(self, *args, **kwargs):
+            if not self.slug:
+                self.slug = slugify(self.title)
+            super().save(*args, **kwargs)
+
+### Flask
+
+    from dz_arabic_slug import slugify
+    new_article.slug = slugify(new_article.title)
+
+### FastAPI
+
+    from fastapi import FastAPI
+    from dz_arabic_slug import slugify
+
+    app = FastAPI()
+
+    @app.post("/articles")
+    def create_article(title: str):
+        return {"slug": slugify(title)}
+
+### Command-line
+
+    arabic-slug "كيف تتعلم البرمجة"
+    # output: kayf-tataealam-albarmaja
+
+## API Reference
+
+### slugify(text, separator="-", max_length=None, allow_arabic=False)
+
+| Parameter | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| text | str | required | Input text |
+| separator | str | "-" | Character between words |
+| max_length | int | None | Max slug length |
+| allow_arabic | bool | False | Keep Arabic chars |
+
+### Examples
+
+    slugify("مرحبا")                        # "marhaba"
+    slugify("Hello مرحبا 2024")             # "hello-marhaba-2024"
+    slugify("مرحبا بك", separator="_")       # "marhaba_bik"
+    slugify("مقال طويل", max_length=10)      # "maqal-tawl"
+    slugify("مرحبا", allow_arabic=True)      # "مرحبا"
+
+## Transliteration Table
+
+| Arabic | Latin | Arabic | Latin |
+| :---: | :---: | :---: | :---: |
+| ا | a | ف | f |
+| ب | b | ق | q |
+| ت | t | ك | k |
+| ث | th | ل | l |
+| ج | j | م | m |
+| ح | h | ن | n |
+| خ | kh | ه | h |
+| د | d | و | w |
+| ذ | dh | ي | y |
+| ر | r | ة | a |
+| ز | z | ال | al |
+| س | s | لا | la |
+| ش | sh | | |
+| ص | s | | |
+| ض | d | | |
+| ط | t | | |
+| ظ | z | | |
+| ع | a | | |
+| غ | gh | | |
+
+Diacritics (tashkeel) are automatically removed.
+
+## Testing
+
+    pytest -v
+
+## Contributing
+
+Contributions are welcome! Please fork, create a branch, add tests, and submit a Pull Request.
+
+## License
+
+MIT (c) 2026 Oussama Boudinar <lionweb01@gmail.com> - dzopensource-lab

dz_arabic_slug-0.1.0/README.md

@@ -0,0 +1,121 @@
+# dz-arabic-slug
+
+Convert Arabic text into clean, URL-friendly slugs with proper transliteration.
+
+[![Tests](https://github.com/dzopensource-lab/dz-arabic-slug/actions/workflows/test.yml/badge.svg)](https://github.com/dzopensource-lab/dz-arabic-slug/actions/workflows/test.yml)
+[![PyPI](https://img.shields.io/pypi/v/dz-arabic-slug.svg)](https://pypi.org/project/dz-arabic-slug/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+Fix the broken Arabic URLs problem in your Django, Flask, or FastAPI project - in one line of code.
+
+## The Problem
+
+Standard slug libraries fail with Arabic:
+
+    slugify("كيف تتعلم البرمجة")  # returns "" (empty!)
+
+This breaks SEO, user experience, and social sharing.
+
+## The Solution
+
+    from dz_arabic_slug import slugify
+    slugify("كيف تتعلم البرمجة")
+    # returns "kayf-tataealam-albarmaja"
+
+## Installation
+
+    pip install dz-arabic-slug
+
+## Quick Start
+
+### Django
+
+    from django.db import models
+    from dz_arabic_slug import slugify
+
+    class Article(models.Model):
+        title = models.CharField(max_length=200)
+        slug = models.SlugField(unique=True, blank=True)
+
+        def save(self, *args, **kwargs):
+            if not self.slug:
+                self.slug = slugify(self.title)
+            super().save(*args, **kwargs)
+
+### Flask
+
+    from dz_arabic_slug import slugify
+    new_article.slug = slugify(new_article.title)
+
+### FastAPI
+
+    from fastapi import FastAPI
+    from dz_arabic_slug import slugify
+
+    app = FastAPI()
+
+    @app.post("/articles")
+    def create_article(title: str):
+        return {"slug": slugify(title)}
+
+### Command-line
+
+    arabic-slug "كيف تتعلم البرمجة"
+    # output: kayf-tataealam-albarmaja
+
+## API Reference
+
+### slugify(text, separator="-", max_length=None, allow_arabic=False)
+
+| Parameter | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| text | str | required | Input text |
+| separator | str | "-" | Character between words |
+| max_length | int | None | Max slug length |
+| allow_arabic | bool | False | Keep Arabic chars |
+
+### Examples
+
+    slugify("مرحبا")                        # "marhaba"
+    slugify("Hello مرحبا 2024")             # "hello-marhaba-2024"
+    slugify("مرحبا بك", separator="_")       # "marhaba_bik"
+    slugify("مقال طويل", max_length=10)      # "maqal-tawl"
+    slugify("مرحبا", allow_arabic=True)      # "مرحبا"
+
+## Transliteration Table
+
+| Arabic | Latin | Arabic | Latin |
+| :---: | :---: | :---: | :---: |
+| ا | a | ف | f |
+| ب | b | ق | q |
+| ت | t | ك | k |
+| ث | th | ل | l |
+| ج | j | م | m |
+| ح | h | ن | n |
+| خ | kh | ه | h |
+| د | d | و | w |
+| ذ | dh | ي | y |
+| ر | r | ة | a |
+| ز | z | ال | al |
+| س | s | لا | la |
+| ش | sh | | |
+| ص | s | | |
+| ض | d | | |
+| ط | t | | |
+| ظ | z | | |
+| ع | a | | |
+| غ | gh | | |
+
+Diacritics (tashkeel) are automatically removed.
+
+## Testing
+
+    pytest -v
+
+## Contributing
+
+Contributions are welcome! Please fork, create a branch, add tests, and submit a Pull Request.
+
+## License
+
+MIT (c) 2026 Oussama Boudinar <lionweb01@gmail.com> - dzopensource-lab

dz_arabic_slug-0.1.0/dz_arabic_slug/__init__.py

@@ -0,0 +1,12 @@
+# Copyright (c) 2026 Oussama Boudinar <lionweb01@gmail.com>
+# SPDX-License-Identifier: MIT
+"""dz-arabic-slug - Convert Arabic text into URL-friendly slugs."""
+
+from dz_arabic_slug.core import slugify
+
+__version__ = "0.1.0"
+__author__ = "Oussama Boudinar"
+__email__ = "lionweb01@gmail.com"
+__license__ = "MIT"
+
+__all__ = ["slugify"]

dz_arabic_slug-0.1.0/dz_arabic_slug/cli.py

@@ -0,0 +1,26 @@
+# Copyright (c) 2026 Oussama Boudinar <lionweb01@gmail.com>
+# SPDX-License-Identifier: MIT
+"""Command-line interface for dz-arabic-slug."""
+
+import sys
+
+from dz_arabic_slug import __author__, __email__, __version__
+from dz_arabic_slug.core import slugify
+
+
+def main():
+    """Convert Arabic text from command line to slug."""
+    if len(sys.argv) < 2:
+        print(f"dz-arabic-slug v{__version__}")
+        print(f"Author: {__author__} <{__email__}>")
+        print("License: MIT")
+        print()
+        print('Usage: arabic-slug "text"')
+        sys.exit(1)
+
+    text = " ".join(sys.argv[1:])
+    print(slugify(text))
+
+
+if __name__ == "__main__":
+    main()

dz_arabic_slug-0.1.0/dz_arabic_slug/core.py

@@ -0,0 +1,60 @@
+# Copyright (c) 2026 Oussama Boudinar <lionweb01@gmail.com>
+# SPDX-License-Identifier: MIT
+"""Core slugify function."""
+
+import re
+import unicodedata
+
+from dz_arabic_slug.mapping import ARABIC_TO_LATIN, COMBINATIONS
+
+_ARABIC_RANGE = re.compile(r"[\u0600-\u06FF]+")
+_NON_WORD = re.compile(r"[^\w\s-]")
+_MULTI_DASH = re.compile(r"[-\s]+")
+
+
+def _is_arabic(char):
+    return bool(_ARABIC_RANGE.match(char))
+
+
+def _transliterate(text):
+    for arabic, latin in COMBINATIONS.items():
+        text = text.replace(arabic, latin)
+
+    result = []
+    for char in text:
+        if _is_arabic(char):
+            result.append(ARABIC_TO_LATIN.get(char, ""))
+        else:
+            result.append(char)
+
+    return "".join(result)
+
+
+def slugify(text, separator="-", max_length=None, allow_arabic=False):
+    """Convert text into a URL-friendly slug.
+
+    Args:
+        text: Input text (Arabic, Latin, or mixed).
+        separator: Character to separate words (default: "-").
+        max_length: Maximum slug length (default: None = unlimited).
+        allow_arabic: Keep Arabic characters instead of transliterating.
+
+    Returns:
+        A URL-safe slug.
+    """
+    if not text:
+        return ""
+
+    text = unicodedata.normalize("NFKD", text)
+
+    if not allow_arabic:
+        text = _transliterate(text)
+
+    text = _NON_WORD.sub("", text)
+    text = _MULTI_DASH.sub(separator, text).strip(separator)
+    text = text.lower()
+
+    if max_length and len(text) > max_length:
+        text = text[:max_length].rstrip(separator)
+
+    return text

dz_arabic_slug-0.1.0/dz_arabic_slug/mapping.py

@@ -0,0 +1,27 @@
+# Copyright (c) 2026 Oussama Boudinar <lionweb01@gmail.com>
+# SPDX-License-Identifier: MIT
+"""Arabic to Latin transliteration mapping."""
+
+ARABIC_TO_LATIN = {
+    "ا": "a", "أ": "a", "إ": "i", "آ": "aa",
+    "ب": "b", "ت": "t", "ث": "th",
+    "ج": "j", "ح": "h", "خ": "kh",
+    "د": "d", "ذ": "dh",
+    "ر": "r", "ز": "z",
+    "س": "s", "ش": "sh",
+    "ص": "s", "ض": "d",
+    "ط": "t", "ظ": "z",
+    "ع": "a", "غ": "gh",
+    "ف": "f", "ق": "q",
+    "ك": "k", "ل": "l",
+    "م": "m", "ن": "n",
+    "ه": "h", "و": "w", "ي": "y",
+    "ى": "a", "ة": "a", "ء": "", "ؤ": "w", "ئ": "y",
+    "َ": "", "ُ": "", "ِ": "", "ْ": "", "ّ": "", "ً": "", "ٌ": "", "ٍ": "",
+    "ـ": "",
+}
+
+COMBINATIONS = {
+    "لا": "la", "لأ": "la", "لإ": "li", "لآ": "laa",
+    "ال": "al",
+}

dz_arabic_slug-0.1.0/dz_arabic_slug.egg-info/PKG-INFO

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: dz-arabic-slug
+Version: 0.1.0
+Summary: Convert Arabic text into URL-friendly slugs with proper transliteration.
+Author-email: Oussama Boudinar <lionweb01@gmail.com>
+Maintainer-email: Oussama Boudinar <lionweb01@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/dzopensource-lab/dz-arabic-slug
+Project-URL: Repository, https://github.com/dzopensource-lab/dz-arabic-slug
+Project-URL: Issues, https://github.com/dzopensource-lab/dz-arabic-slug/issues
+Keywords: slug,arabic,slugify,url,transliteration,django,flask,fastapi
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Natural Language :: Arabic
+Classifier: Topic :: Text Processing :: Linguistic
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# dz-arabic-slug
+
+Convert Arabic text into clean, URL-friendly slugs with proper transliteration.
+
+[![Tests](https://github.com/dzopensource-lab/dz-arabic-slug/actions/workflows/test.yml/badge.svg)](https://github.com/dzopensource-lab/dz-arabic-slug/actions/workflows/test.yml)
+[![PyPI](https://img.shields.io/pypi/v/dz-arabic-slug.svg)](https://pypi.org/project/dz-arabic-slug/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+Fix the broken Arabic URLs problem in your Django, Flask, or FastAPI project - in one line of code.
+
+## The Problem
+
+Standard slug libraries fail with Arabic:
+
+    slugify("كيف تتعلم البرمجة")  # returns "" (empty!)
+
+This breaks SEO, user experience, and social sharing.
+
+## The Solution
+
+    from dz_arabic_slug import slugify
+    slugify("كيف تتعلم البرمجة")
+    # returns "kayf-tataealam-albarmaja"
+
+## Installation
+
+    pip install dz-arabic-slug
+
+## Quick Start
+
+### Django
+
+    from django.db import models
+    from dz_arabic_slug import slugify
+
+    class Article(models.Model):
+        title = models.CharField(max_length=200)
+        slug = models.SlugField(unique=True, blank=True)
+
+        def save(self, *args, **kwargs):
+            if not self.slug:
+                self.slug = slugify(self.title)
+            super().save(*args, **kwargs)
+
+### Flask
+
+    from dz_arabic_slug import slugify
+    new_article.slug = slugify(new_article.title)
+
+### FastAPI
+
+    from fastapi import FastAPI
+    from dz_arabic_slug import slugify
+
+    app = FastAPI()
+
+    @app.post("/articles")
+    def create_article(title: str):
+        return {"slug": slugify(title)}
+
+### Command-line
+
+    arabic-slug "كيف تتعلم البرمجة"
+    # output: kayf-tataealam-albarmaja
+
+## API Reference
+
+### slugify(text, separator="-", max_length=None, allow_arabic=False)
+
+| Parameter | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| text | str | required | Input text |
+| separator | str | "-" | Character between words |
+| max_length | int | None | Max slug length |
+| allow_arabic | bool | False | Keep Arabic chars |
+
+### Examples
+
+    slugify("مرحبا")                        # "marhaba"
+    slugify("Hello مرحبا 2024")             # "hello-marhaba-2024"
+    slugify("مرحبا بك", separator="_")       # "marhaba_bik"
+    slugify("مقال طويل", max_length=10)      # "maqal-tawl"
+    slugify("مرحبا", allow_arabic=True)      # "مرحبا"
+
+## Transliteration Table
+
+| Arabic | Latin | Arabic | Latin |
+| :---: | :---: | :---: | :---: |
+| ا | a | ف | f |
+| ب | b | ق | q |
+| ت | t | ك | k |
+| ث | th | ل | l |
+| ج | j | م | m |
+| ح | h | ن | n |
+| خ | kh | ه | h |
+| د | d | و | w |
+| ذ | dh | ي | y |
+| ر | r | ة | a |
+| ز | z | ال | al |
+| س | s | لا | la |
+| ش | sh | | |
+| ص | s | | |
+| ض | d | | |
+| ط | t | | |
+| ظ | z | | |
+| ع | a | | |
+| غ | gh | | |
+
+Diacritics (tashkeel) are automatically removed.
+
+## Testing
+
+    pytest -v
+
+## Contributing
+
+Contributions are welcome! Please fork, create a branch, add tests, and submit a Pull Request.
+
+## License
+
+MIT (c) 2026 Oussama Boudinar <lionweb01@gmail.com> - dzopensource-lab

dz_arabic_slug-0.1.0/dz_arabic_slug.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+pyproject.toml
+dz_arabic_slug/__init__.py
+dz_arabic_slug/cli.py
+dz_arabic_slug/core.py
+dz_arabic_slug/mapping.py
+dz_arabic_slug.egg-info/PKG-INFO
+dz_arabic_slug.egg-info/SOURCES.txt
+dz_arabic_slug.egg-info/dependency_links.txt
+dz_arabic_slug.egg-info/entry_points.txt
+dz_arabic_slug.egg-info/top_level.txt
+tests/test_core.py

dz_arabic_slug-0.1.0/dz_arabic_slug.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

dz_arabic_slug-0.1.0/dz_arabic_slug.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+arabic-slug = dz_arabic_slug.cli:main

dz_arabic_slug-0.1.0/dz_arabic_slug.egg-info/top_level.txt

@@ -0,0 +1 @@
+dz_arabic_slug

dz_arabic_slug-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools>=77.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "dz-arabic-slug"
+version = "0.1.0"
+description = "Convert Arabic text into URL-friendly slugs with proper transliteration."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Oussama Boudinar", email = "lionweb01@gmail.com" }]
+maintainers = [{ name = "Oussama Boudinar", email = "lionweb01@gmail.com" }]
+keywords = ["slug", "arabic", "slugify", "url", "transliteration", "django", "flask", "fastapi"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Natural Language :: Arabic",
+    "Topic :: Text Processing :: Linguistic",
+]
+dependencies = []
+
+[project.scripts]
+arabic-slug = "dz_arabic_slug.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/dzopensource-lab/dz-arabic-slug"
+Repository = "https://github.com/dzopensource-lab/dz-arabic-slug"
+Issues = "https://github.com/dzopensource-lab/dz-arabic-slug/issues"
+
+[tool.setuptools.packages.find]
+include = ["dz_arabic_slug*"]

dz_arabic_slug-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

dz_arabic_slug-0.1.0/tests/test_core.py

@@ -0,0 +1,63 @@
+# Copyright (c) 2026 Oussama Boudinar <lionweb01@gmail.com>
+# SPDX-License-Identifier: MIT
+"""Tests for dz_arabic_slug."""
+
+from dz_arabic_slug import slugify
+
+
+def test_simple_arabic():
+    assert slugify("مرحبا") == "mrhba"
+
+
+def test_arabic_sentence():
+    assert slugify("كيف تتعلم البرمجة") == "kyf-ttalm-albrmja"
+
+
+def test_mixed_text():
+    assert slugify("Hello مرحبا") == "hello-mrhba"
+
+
+def test_with_numbers():
+    assert slugify("مقال 2024") == "mqal-2024"
+
+
+def test_empty_string():
+    assert slugify("") == ""
+
+
+def test_only_spaces():
+    assert slugify("   ") == ""
+
+
+def test_custom_separator():
+    assert slugify("مرحبا بك", separator="_") == "mrhba_bk"
+
+
+def test_max_length():
+    result = slugify("مقال طويل جدا عن البرمجة", max_length=10)
+    assert len(result) <= 10
+
+
+def test_allow_arabic():
+    assert slugify("مرحبا", allow_arabic=True) == "مرحبا"
+
+
+def test_special_characters():
+    assert slugify("مرحبا!@#") == "mrhba"
+
+
+def test_english_only():
+    assert slugify("Hello World") == "hello-world"
+
+
+def test_al_definite_article():
+    assert slugify("البرمجة") == "albrmja"
+
+
+def test_tashkeel_removed():
+    assert slugify("مَرْحَبًا") == "mrhba"
+
+
+def test_tashkeel_same_as_plain():
+    # With or without diacritics, same result
+    assert slugify("مَرْحَبًا") == slugify("مرحبا")