-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,48 @@ | ||
|
||
# arabic2latin | ||
|
||
Convert Arabic characters to their Latin (English) homophone. | ||
|
||
|
||
## Installation | ||
|
||
Install from source: | ||
|
||
```bash | ||
pip install git+https://github.com/rexa222/arabic2latin | ||
``` | ||
Alternatively, install from PyPI: | ||
```bash | ||
pip install arabic2latin | ||
``` | ||
## Usage/Examples | ||
|
||
```python | ||
from arabic2latin import arabic_to_latin | ||
|
||
arabic_text = "السَّلَامُ عَلَيْكَ" | ||
converted_text = arabic_to_latin(arabic_text) | ||
|
||
print(converted_text) | ||
``` | ||
Output: | ||
```text | ||
alsaalaamo aalayka | ||
``` | ||
## Debug Mode | ||
If you came across a character that was not converted, you can find it using debug feature and report it as guided in the contributing section. | ||
```text | ||
converted_text = arabic_to_latin(arabic_text, debug=True) | ||
``` | ||
Output: | ||
```text | ||
unknown character: ? | ||
``` | ||
|
||
|
||
|
||
|
||
## Contributing | ||
|
||
If you find a bug 🐛, please open a [bug report](https://github.com/rexa222/arabic2latin/issues/new?assignees=&labels=bug&template=bug_report.md&title=). If you have an idea for an improvement or new feature 🚀, please open a [feature request](https://github.com/rexa222/arabic2latin/issues/new?assignees=&labels=Feature+request&template=feature_request.md&title=). | ||
|