# UzSyllable
https://pypi.org/project/UzSyllable <br>
https://github.com/UlugbekSalaev/UzSyllable
UzSyllable tool is focused to make division of syllables and end of line breaks of Uzbek language. The tool includes Syllabification, End-of-Line, Count of Syllables methods.
It is created as a python library and uploaded to [PyPI](https://pypi.org/). It is simply easy to use in your python project or other programming language projects via the API.
## About project
The UzSyllable project is a text processing tool that includes three main methods: syllabification, end-of-line, and count of syllables. Syllabification involves dividing words in Uzbek text into their constituent syllables, which can be useful for pronunciation, spelling, and linguistic analysis. End-of-line justification involves determining the appropriate places to break lines in Uzbek text, which can improve the readability and aesthetics of written materials. Count of syllables involves counting the number of syllables in a given word or sentence, which can be useful for metrics such as rhyme and meter in poetry or for determining the complexity of a text. The UzSyllable project uses machine learning algorithms and linguistic rules to perform these methods accurately and efficiently on Uzbek text.
## Quick links
- [Github](https://github.com/UlugbekSalaev/UzSyllable)
- [PyPI](https://pypi.org/project/UzSyllable/)
- [Web-UI](https://nlp.urdu.uz/?menu=uzsyllable)
## Features
- Syllabification
- Hyphenation
- Count of Syllables
## Usage
Three options to use UzSyllable:
- pip
- Web tool
- API
## pip installation
To install UzSyllable, simply run:
```code
pip install UzSyllable
```
After installation, use in python like following:
### Syllabification
```code
from UzSyllable import syllables
print(syllables('maktabimda'))
# Output : ['mak-ta-bim-da']
print(syllables('мактабимда'))
# Output : ['мак-та-бим-да']
```
### Hyphenation
```code
from UzSyllable import hyphenation
# call hyphenation method
print(hyphenation('maktabimda'))
# Output : ['mak-tabimda', 'makta-bimda', 'maktabim-da']
```
### Count of Syllables
```code
from UzSyllable import count
# call count of syllables method
print(count('maktabimda'))
# Output : 4
```
## Web interface
You can use [web interface](https://nlp.urdu.uz/?menu=uzsyllable).
<img width="1437" alt="image" src="https://github.com/UlugbekSalaev/UzSyllable/assets/71002671/ee3bc563-35d8-4d15-bcd0-6cbad8a6107a">
## API
### Syllabification
- #### URL: https://api.urdu.uz/syllables
- #### Method: POST
- #### Parametres: word
- #### Example Request: https://api.urdu.uz/syllables?word=maktab
### Hyphenation
- #### URL: https://api.urdu.uz/line-break-syllables
- #### Method: POST
- #### Parametres: word
- #### Example Request: https://api.urdu.uz/line-break-syllables?word=maktabgacha
### Count of Syllables
- #### URL: https://api.urdu.uz/count-syllables
- #### Method: POST
- #### Parametres: word
- #### Example Request: https://api.urdu.uz/count-syllables?word=maktabgacha
## Citation
```tex
@misc{UzSyllable,
title={UzSyllable}: Syllabification Tool for Uzbek},
url={https://github.com/UlugbekSalaev/UzSyllable},
note={Software available from https://github.com/UlugbekSalaev/UzSyllable},
author={
Ulugbek Salaev},
year={2023},
}
```
## Contact
For help and feedback, please feel free to contact [the author](https://github.com/UlugbekSalaev).
Raw data
{
"_id": null,
"home_page": "https://github.com/UlugbekSalaev/UzSyllable",
"name": "UzSyllable",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "syllable,hyphenation,uzbek-language",
"author": "Ulugbek Salaev",
"author_email": "ulugbek0302@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/58/b2/43ffa2564871c3312643da6677bc41ad4d66b0ccacdc8b146e4388bb3d2e/UzSyllable-0.0.8.tar.gz",
"platform": null,
"description": "# UzSyllable\r\n\r\nhttps://pypi.org/project/UzSyllable <br>\r\nhttps://github.com/UlugbekSalaev/UzSyllable\r\n\r\nUzSyllable tool is focused to make division of syllables and end of line breaks of Uzbek language. The tool includes Syllabification, End-of-Line, Count of Syllables methods.\r\nIt is created as a python library and uploaded to [PyPI](https://pypi.org/). It is simply easy to use in your python project or other programming language projects via the API. \r\n\r\n## About project\r\nThe UzSyllable project is a text processing tool that includes three main methods: syllabification, end-of-line, and count of syllables. Syllabification involves dividing words in Uzbek text into their constituent syllables, which can be useful for pronunciation, spelling, and linguistic analysis. End-of-line justification involves determining the appropriate places to break lines in Uzbek text, which can improve the readability and aesthetics of written materials. Count of syllables involves counting the number of syllables in a given word or sentence, which can be useful for metrics such as rhyme and meter in poetry or for determining the complexity of a text. The UzSyllable project uses machine learning algorithms and linguistic rules to perform these methods accurately and efficiently on Uzbek text.\r\n## Quick links\r\n\r\n- [Github](https://github.com/UlugbekSalaev/UzSyllable)\r\n- [PyPI](https://pypi.org/project/UzSyllable/)\r\n- [Web-UI](https://nlp.urdu.uz/?menu=uzsyllable)\r\n\r\n\r\n## Features\r\n\r\n- Syllabification\r\n- Hyphenation\r\n- Count of Syllables\r\n\r\n## Usage\r\n\r\nThree options to use UzSyllable:\r\n\r\n- pip\r\n- Web tool\r\n- API\r\n\r\n## pip installation\r\n\r\nTo install UzSyllable, simply run:\r\n\r\n```code\r\npip install UzSyllable\r\n```\r\n\r\nAfter installation, use in python like following:\r\n\r\n### Syllabification\r\n```code\r\nfrom UzSyllable import syllables\r\nprint(syllables('maktabimda'))\r\n# Output : ['mak-ta-bim-da']\r\n\r\nprint(syllables('\u043c\u0430\u043a\u0442\u0430\u0431\u0438\u043c\u0434\u0430'))\r\n# Output : ['\u043c\u0430\u043a-\u0442\u0430-\u0431\u0438\u043c-\u0434\u0430']\r\n```\r\n\r\n### Hyphenation\r\n```code\r\nfrom UzSyllable import hyphenation\r\n# call hyphenation method\r\nprint(hyphenation('maktabimda'))\r\n# Output : ['mak-tabimda', 'makta-bimda', 'maktabim-da']\r\n```\r\n\r\n### Count of Syllables\r\n```code\r\nfrom UzSyllable import count\r\n# call count of syllables method\r\nprint(count('maktabimda'))\r\n# Output : 4\r\n```\r\n\r\n\r\n## Web interface\r\n\r\nYou can use [web interface](https://nlp.urdu.uz/?menu=uzsyllable).\r\n\r\n<img width=\"1437\" alt=\"image\" src=\"https://github.com/UlugbekSalaev/UzSyllable/assets/71002671/ee3bc563-35d8-4d15-bcd0-6cbad8a6107a\">\r\n\r\n\r\n## API\r\n\r\n### Syllabification\r\n\r\n- #### URL: https://api.urdu.uz/syllables\r\n- #### Method: POST\r\n- #### Parametres: word\r\n- #### Example Request: https://api.urdu.uz/syllables?word=maktab\r\n\r\n\r\n### Hyphenation\r\n\r\n- #### URL: https://api.urdu.uz/line-break-syllables\r\n- #### Method: POST\r\n- #### Parametres: word\r\n- #### Example Request: https://api.urdu.uz/line-break-syllables?word=maktabgacha\r\n\r\n\r\n### Count of Syllables\r\n\r\n- #### URL: https://api.urdu.uz/count-syllables\r\n- #### Method: POST\r\n- #### Parametres: word\r\n- #### Example Request: https://api.urdu.uz/count-syllables?word=maktabgacha\r\n\r\n\r\n## Citation\r\n\r\n```tex\r\n@misc{UzSyllable,\r\n title={UzSyllable}: Syllabification Tool for Uzbek},\r\n url={https://github.com/UlugbekSalaev/UzSyllable},\r\n note={Software available from https://github.com/UlugbekSalaev/UzSyllable},\r\n author={\r\n Ulugbek Salaev},\r\n year={2023},\r\n}\r\n```\r\n\r\n## Contact\r\n\r\nFor help and feedback, please feel free to contact [the author](https://github.com/UlugbekSalaev).\r\n",
"bugtrack_url": null,
"license": "",
"summary": "UzSyllable | The Syllable Separator, Line breaks and Counter for Uzbek Language",
"version": "0.0.8",
"project_urls": {
"Bug Tracker": "https://github.com/UlugbekSalaev/UzSyllable/issues",
"Homepage": "https://github.com/UlugbekSalaev/UzSyllable"
},
"split_keywords": [
"syllable",
"hyphenation",
"uzbek-language"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7a27492b8f39fff779ff5d4e65cd51998e11f17f9187a1f909cf63dbf03af7fb",
"md5": "70b25662add0a7f6cb65e362bc63bb8c",
"sha256": "e167649231d28a49a44ef37220600ae6706adf757487bee78daeb1b7d74c407f"
},
"downloads": -1,
"filename": "UzSyllable-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "70b25662add0a7f6cb65e362bc63bb8c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4949,
"upload_time": "2023-08-03T08:39:12",
"upload_time_iso_8601": "2023-08-03T08:39:12.121044Z",
"url": "https://files.pythonhosted.org/packages/7a/27/492b8f39fff779ff5d4e65cd51998e11f17f9187a1f909cf63dbf03af7fb/UzSyllable-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "58b243ffa2564871c3312643da6677bc41ad4d66b0ccacdc8b146e4388bb3d2e",
"md5": "c7f6ab1acf3114dc26f7ab32870f9234",
"sha256": "4e4cbf42831a9b846a739122131e2dc95d4b1f9dac96e688874fc4f988ead045"
},
"downloads": -1,
"filename": "UzSyllable-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "c7f6ab1acf3114dc26f7ab32870f9234",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4834,
"upload_time": "2023-08-03T08:39:14",
"upload_time_iso_8601": "2023-08-03T08:39:14.577449Z",
"url": "https://files.pythonhosted.org/packages/58/b2/43ffa2564871c3312643da6677bc41ad4d66b0ccacdc8b146e4388bb3d2e/UzSyllable-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-03 08:39:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "UlugbekSalaev",
"github_project": "UzSyllable",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "uzsyllable"
}
JSON
