nairaxo/shialifube

Transliteration of Comorian into Arabic Script # ShiAlifube ## About **ShiAlifube** is a Python library for transliterating Comorian into Arabic script using the Kamar-Eddine system. This system was proposed in the 1960s by Cheikh Ahmed Kamar-Eddine, a pioneer in the standardization of the Comorian language. The choice of Arabic script is due to the Comorian language's lexical borrowings from Arabic, reflecting the historical influence of Arabs in the Comoros archipelago. ## Features - Provides transliteration from Comorian to Arabic script. - Supports various Comorian dialects. - Easy to integrate into Python projects. ## Goals - To offer a robust tool for Comorian language preservation. - To facilitate research and development in language technology for Comorian. # Installation ## Via PyPI You can install **ShiAlifube** directly from PyPI using `pip`: ```bash pip install shialifube ``` ## Via GitHub If you wish to install the latest version from the GitHub repository (which may contain updates not yet published on PyPI), you can do so using pip with the repository URL: ```bash pip install git+github.com ``` # Usage To use **ShiAlifube** in your Python project, import the main `transliterate` function from the library, and pass it the Comorian text you want to transliterate. Here’s a simple example: ```python from shialifube import transliterate # Example text in Comorian text = "ye mwana hende likoli" # Use the transliteration function trans = transliterate(text) # Display the text transliterated into Arabic script print(trans) # >> ي‍ہ‍ موﺍنﺍ ح‍ہ‍ند‍ہ‍ ليكهلي ``` # Contributions Welcome Given the limited availability of documents on the Kamar-Eddine system, we invite the community to share any information, resources, or insights that could contribute to improving the ShiAlifube library. Your contributions are valuable in enhancing the accuracy and functionality of this tool, and we greatly appreciate any support in this endeavor. # Citation If you use **ShiAlif …