# Aksarantara
Aksarantara is a framework specially for **Sanskrit** enthausists supporting indic, eastern, roman and other language transliteration. Aksarantara is also written in [Ruby](https://github.com/enginestein/aksarantara.rb) and [PHP](https://github.com/enginestein/aksarantara.php) but this Python version is the best. The PHP and Ruby version need further updates.
# Installation
To install Aksarantara
```powershell
pip install aksarantara
```
To use Aksarantara
the `transliterate.process` function is the main function which has following parameters:
```python
transliterate.process(src, tgt, txt, nativize = True, pre_options = [], post_options = [])
```
| Paremeter | Usage |
| ------------- | ------------- |
| src: str | Used to provide the source transliteration script |
| tgt: str | Used to provide target transliteration script |
| txt: str | Provide text to be transliterated |
| navitize: bool | navitize the text |
| pre_options: list | Options to customize input (source) string for processing |
| post_options: list | Options to customize output (target) string for processing |
# Usage
```python
from aksrantara import transliterate
print(transliterate.process("hk", "siddham", "mataram"))
print(transliterate.process("autodetect", "iast", "அம்மாவை வணங்குகிறேன்"))
print(transliterate.process("hk", "Tamil", "அம்மாவை வணங்குகிறேன்", False))
print(transliterate.process("HK","Tamil","அம்மாவை வணங்குகிறேன்", False, post_options=["TamilSubScript", "TamilRemoveApostrophe"]))
print(transliterate.process("Thai", "Devanagari", "ภุทธัง สะระณัง คัจฉามิ", pre_options=["ThaiOrthography"]))
print(transliterate.process("autodetect", "IAST", "สวัสดีประเทศชาติ"))
print(transliterate.process("autodetect", "Vatteluttu", "สวัสดีประเทศชาติ"))
print(transliterate.auto_detect("வாழ்க இந்தியா"))
print(transliterate.process("Devanagari", "IAST", "सर्वे भवन्तु सुखिनः", pre_options=["RemoveSchwaHindi"]))
print(transliterate.process("deva", "taml", "वन्दे मातरम ", param="script_code"))
print(transliterate.process("te", "ur", "వందే భారత్ మాతరం", param="lang_code"))
print(transliterate.process("odia", "ho", "వందే భారత్ మాతరం", param="lang_name"))
print(transliterate.process("hindi", "kannada", "वन्दे मातरम ", param="lang_name"))
print(transliterate.process("devanagari", "granthapandya", "धर्म"))
print(transliterate.process("hi", "pa", "वन्दे मातरम ", param="lang_code"))
print(transliterate.process("deva", "arab", "वन्दे मातरम ", param="script_code"))
print(transliterate.process("autodetect", "latn-iast", "वन्दे मातरम ", param="script_code"))
print(transliterate.process("la-HK", "pa-guru", "namo buddhAya", param="lang_code"))
print(transliterate.process("hi-Deva", "hi-kthi", "वन्दे मातरम ", param="lang_code"))
print(transliterate.process("hi-Deva", "mak", "वन्दे मातरम ", param="lang_code"))
print(transliterate.process("hi-Deva", "cyrl", "वन्दे मातरम ", param="script_code"))
print(transliterate.process("sa-Deva", "ru", "वन्दे मातरम ", param="lang_code"))
print(transliterate.process("deva", "taml", "वन्दे मातरम ", param="script_code"))
print(transliterate.process("te", "ur", "వందే భారత్ మాతరం", param="lang_code"))
print(transliterate.process("odia", "ho", "వందే భారత్ మాతరం", param="lang_name"))
print(transliterate.process("Devanagari", "Phnx", "वयं अभियंताः स्मः"))
print(transliterate.process("HK", "Syrc", "buddha"))
```
Raw data
{
"_id": null,
"home_page": "https://github.com/enginestein/Aksarantara",
"name": "Aksarantara",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Arya Praneil Pritesh",
"author_email": "aryapraneil@gmail.com",
"download_url": "",
"platform": null,
"description": "# Aksarantara\r\n\r\nAksarantara is a framework specially for **Sanskrit** enthausists supporting indic, eastern, roman and other language transliteration. Aksarantara is also written in [Ruby](https://github.com/enginestein/aksarantara.rb) and [PHP](https://github.com/enginestein/aksarantara.php) but this Python version is the best. The PHP and Ruby version need further updates.\r\n\r\n# Installation\r\n\r\nTo install Aksarantara\r\n\r\n```powershell\r\npip install aksarantara\r\n```\r\n\r\nTo use Aksarantara\r\n\r\nthe `transliterate.process` function is the main function which has following parameters:\r\n\r\n```python\r\ntransliterate.process(src, tgt, txt, nativize = True, pre_options = [], post_options = [])\r\n```\r\n\r\n| Paremeter | Usage |\r\n| ------------- | ------------- |\r\n| src: str | Used to provide the source transliteration script |\r\n| tgt: str | Used to provide target transliteration script |\r\n| txt: str | Provide text to be transliterated |\r\n| navitize: bool | navitize the text |\r\n| pre_options: list | Options to customize input (source) string for processing |\r\n| post_options: list | Options to customize output (target) string for processing |\r\n\r\n# Usage\r\n\r\n```python\r\nfrom aksrantara import transliterate\r\n\r\nprint(transliterate.process(\"hk\", \"siddham\", \"mataram\"))\r\nprint(transliterate.process(\"autodetect\", \"iast\", \"\u0b85\u0bae\u0bcd\u0bae\u0bbe\u0bb5\u0bc8 \u0bb5\u0ba3\u0b99\u0bcd\u0b95\u0bc1\u0b95\u0bbf\u0bb1\u0bc7\u0ba9\u0bcd\"))\r\nprint(transliterate.process(\"hk\", \"Tamil\", \"\u0b85\u0bae\u0bcd\u0bae\u0bbe\u0bb5\u0bc8 \u0bb5\u0ba3\u0b99\u0bcd\u0b95\u0bc1\u0b95\u0bbf\u0bb1\u0bc7\u0ba9\u0bcd\", False))\r\nprint(transliterate.process(\"HK\",\"Tamil\",\"\u0b85\u0bae\u0bcd\u0bae\u0bbe\u0bb5\u0bc8 \u0bb5\u0ba3\u0b99\u0bcd\u0b95\u0bc1\u0b95\u0bbf\u0bb1\u0bc7\u0ba9\u0bcd\", False, post_options=[\"TamilSubScript\", \"TamilRemoveApostrophe\"]))\r\nprint(transliterate.process(\"Thai\", \"Devanagari\", \"\u0e20\u0e38\u0e17\u0e18\u0e31\u0e07 \u0e2a\u0e30\u0e23\u0e30\u0e13\u0e31\u0e07 \u0e04\u0e31\u0e08\u0e09\u0e32\u0e21\u0e34\", pre_options=[\"ThaiOrthography\"]))\r\nprint(transliterate.process(\"autodetect\", \"IAST\", \"\u0e2a\u0e27\u0e31\u0e2a\u0e14\u0e35\u0e1b\u0e23\u0e30\u0e40\u0e17\u0e28\u0e0a\u0e32\u0e15\u0e34\"))\r\nprint(transliterate.process(\"autodetect\", \"Vatteluttu\", \"\u0e2a\u0e27\u0e31\u0e2a\u0e14\u0e35\u0e1b\u0e23\u0e30\u0e40\u0e17\u0e28\u0e0a\u0e32\u0e15\u0e34\"))\r\nprint(transliterate.auto_detect(\"\u0bb5\u0bbe\u0bb4\u0bcd\u0b95 \u0b87\u0ba8\u0bcd\u0ba4\u0bbf\u0baf\u0bbe\"))\r\nprint(transliterate.process(\"Devanagari\", \"IAST\", \"\u0938\u0930\u094d\u0935\u0947 \u092d\u0935\u0928\u094d\u0924\u0941 \u0938\u0941\u0916\u093f\u0928\u0903\", pre_options=[\"RemoveSchwaHindi\"]))\r\nprint(transliterate.process(\"deva\", \"taml\", \"\u0935\u0928\u094d\u0926\u0947 \u092e\u093e\u0924\u0930\u092e \", param=\"script_code\"))\r\nprint(transliterate.process(\"te\", \"ur\", \"\u0c35\u0c02\u0c26\u0c47 \u0c2d\u0c3e\u0c30\u0c24\u0c4d \u0c2e\u0c3e\u0c24\u0c30\u0c02\", param=\"lang_code\"))\r\nprint(transliterate.process(\"odia\", \"ho\", \"\u0c35\u0c02\u0c26\u0c47 \u0c2d\u0c3e\u0c30\u0c24\u0c4d \u0c2e\u0c3e\u0c24\u0c30\u0c02\", param=\"lang_name\"))\r\nprint(transliterate.process(\"hindi\", \"kannada\", \"\u0935\u0928\u094d\u0926\u0947 \u092e\u093e\u0924\u0930\u092e \", param=\"lang_name\"))\r\nprint(transliterate.process(\"devanagari\", \"granthapandya\", \"\u0927\u0930\u094d\u092e\"))\r\nprint(transliterate.process(\"hi\", \"pa\", \"\u0935\u0928\u094d\u0926\u0947 \u092e\u093e\u0924\u0930\u092e \", param=\"lang_code\"))\r\nprint(transliterate.process(\"deva\", \"arab\", \"\u0935\u0928\u094d\u0926\u0947 \u092e\u093e\u0924\u0930\u092e \", param=\"script_code\"))\r\nprint(transliterate.process(\"autodetect\", \"latn-iast\", \"\u0935\u0928\u094d\u0926\u0947 \u092e\u093e\u0924\u0930\u092e \", param=\"script_code\"))\r\nprint(transliterate.process(\"la-HK\", \"pa-guru\", \"namo buddhAya\", param=\"lang_code\"))\r\nprint(transliterate.process(\"hi-Deva\", \"hi-kthi\", \"\u0935\u0928\u094d\u0926\u0947 \u092e\u093e\u0924\u0930\u092e \", param=\"lang_code\"))\r\nprint(transliterate.process(\"hi-Deva\", \"mak\", \"\u0935\u0928\u094d\u0926\u0947 \u092e\u093e\u0924\u0930\u092e \", param=\"lang_code\"))\r\nprint(transliterate.process(\"hi-Deva\", \"cyrl\", \"\u0935\u0928\u094d\u0926\u0947 \u092e\u093e\u0924\u0930\u092e \", param=\"script_code\"))\r\nprint(transliterate.process(\"sa-Deva\", \"ru\", \"\u0935\u0928\u094d\u0926\u0947 \u092e\u093e\u0924\u0930\u092e \", param=\"lang_code\"))\r\nprint(transliterate.process(\"deva\", \"taml\", \"\u0935\u0928\u094d\u0926\u0947 \u092e\u093e\u0924\u0930\u092e \", param=\"script_code\"))\r\nprint(transliterate.process(\"te\", \"ur\", \"\u0c35\u0c02\u0c26\u0c47 \u0c2d\u0c3e\u0c30\u0c24\u0c4d \u0c2e\u0c3e\u0c24\u0c30\u0c02\", param=\"lang_code\"))\r\nprint(transliterate.process(\"odia\", \"ho\", \"\u0c35\u0c02\u0c26\u0c47 \u0c2d\u0c3e\u0c30\u0c24\u0c4d \u0c2e\u0c3e\u0c24\u0c30\u0c02\", param=\"lang_name\"))\r\nprint(transliterate.process(\"Devanagari\", \"Phnx\", \"\u0935\u092f\u0902 \u0905\u092d\u093f\u092f\u0902\u0924\u093e\u0903 \u0938\u094d\u092e\u0903\"))\r\nprint(transliterate.process(\"HK\", \"Syrc\", \"buddha\"))\r\n```\r\n",
"bugtrack_url": null,
"license": "GNU GPL 3.0",
"summary": "Transliteration framework for Indic language mainly focusing on Sanskrit",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/enginestein/Aksarantara"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fe9d1fb036168d38e124f7fec68e5f472e82a268854e7b241e692af21142d357",
"md5": "440ced181d21045c338c19e6e346b449",
"sha256": "4f173733cb4e19e3d861cc80d368f9fdf39a5b7d8b71e651da086b779f742dc1"
},
"downloads": -1,
"filename": "Aksarantara-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "440ced181d21045c338c19e6e346b449",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 107845,
"upload_time": "2023-08-18T03:38:02",
"upload_time_iso_8601": "2023-08-18T03:38:02.464837Z",
"url": "https://files.pythonhosted.org/packages/fe/9d/1fb036168d38e124f7fec68e5f472e82a268854e7b241e692af21142d357/Aksarantara-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-18 03:38:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "enginestein",
"github_project": "Aksarantara",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "aksarantara"
}
JSON
