# Persian Gender Detection
A simple python package to detect gender by Persian first name. (With more than 19K names)
for this package i use this [repo](https://github.com/peymanslh/persian-gender-detection/) if you are use NPM that's great choice.
Installation
------
Install with PIP:
```bash
$ pip install persian-gender-detection
```
Example
------
```python
from persian_gender_detection import get_gender
# Detect gender
get_gender(' عــــلی ') # MALE
get_gender('نرگـــ😉ــس') # FEMALE
get_gender('حســ😎ــن') # MALE
get_gender('۱۲۳۹۹۳محمدعلی123') # MALE
get_gender('۱۲۳مهناز۱۲۳') # FEMALE
get_gender('فاطمه زهرا') # UNKNOWN
get_gender('فاطمه زهرا',
find_nearest_name=True) # (FEMALE, 'فاطمه')
get_gender('محمدنیسنممدیتیس',
find_nearest_name=True) # ('MALE', 'محمد')
```
Changelog
------
1.2.1
* Fixed issues in two-part names and added find_nearst_name flag to find and return the nearest name.
1.1.0
* Increasing the dataset of names from 6k to 19k
* convert names dataset from JSON to Python dictionary
* If a name does not exist in the dataset, it finds the gender in two-part names using the first part.
1.0.5
* First version with 6k name dataset
Issues
------
Feel free to submit issues and enhancement requests.
Contributing
------------
Please feel free to contribute names database with your kindly pull requests.
License
------------
Licensed under [MIT License](LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/zeoses/persian-gender-detection",
"name": "persian-gender-detection",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "persian-gender-detection,farsi gender,iranian gender,name gender,persian gender detection,gender detection",
"author": "Mehraban",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/74/f2/552c961fff067288c145b3f6a12be6cba31fa200702bbacb1c37df12bacf/persian-gender-detection-1.2.1.tar.gz",
"platform": null,
"description": "# Persian Gender Detection\n\nA simple python package to detect gender by Persian first name. (With more than 19K names)\n\nfor this package i use this [repo](https://github.com/peymanslh/persian-gender-detection/) if you are use NPM that's great choice.\n\nInstallation\n------\nInstall with PIP:\n\n```bash\n$ pip install persian-gender-detection\n```\n\nExample\n------\n```python\nfrom persian_gender_detection import get_gender\n\n# Detect gender\nget_gender(' \u0639\u0640\u0640\u0640\u0640\u0644\u06cc ') # MALE\nget_gender('\u0646\u0631\u06af\u0640\u0640\u0640\ud83d\ude09\u0640\u0640\u0633') # FEMALE\nget_gender('\u062d\u0633\u0640\u0640\ud83d\ude0e\u0640\u0640\u0646') # MALE\nget_gender('\u06f1\u06f2\u06f3\u06f9\u06f9\u06f3\u0645\u062d\u0645\u062f\u0639\u0644\u06cc123') # MALE\nget_gender('\u06f1\u06f2\u06f3\u0645\u0647\u0646\u0627\u0632\u06f1\u06f2\u06f3') # FEMALE\nget_gender('\u0641\u0627\u0637\u0645\u0647 \u0632\u0647\u0631\u0627') # UNKNOWN\nget_gender('\u0641\u0627\u0637\u0645\u0647 \u0632\u0647\u0631\u0627', \n find_nearest_name=True) # (FEMALE, '\u0641\u0627\u0637\u0645\u0647')\nget_gender('\u0645\u062d\u0645\u062f\u0646\u06cc\u0633\u0646\u0645\u0645\u062f\u06cc\u062a\u06cc\u0633', \n find_nearest_name=True) # ('MALE', '\u0645\u062d\u0645\u062f')\n\n```\nChangelog\n------\n1.2.1\n* Fixed issues in two-part names and added find_nearst_name flag to find and return the nearest name. \n\n1.1.0 \n* Increasing the dataset of names from 6k to 19k\n* convert names dataset from JSON to Python dictionary\n* If a name does not exist in the dataset, it finds the gender in two-part names using the first part. \n\n1.0.5\n* First version with 6k name dataset\n\nIssues\n------\n\nFeel free to submit issues and enhancement requests.\n\nContributing\n------------\n\nPlease feel free to contribute names database with your kindly pull requests.\n\nLicense\n------------\nLicensed under [MIT License](LICENSE)\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A simple python package to detect gender by Persian first name. (With more than 19K names).",
"version": "1.2.1",
"project_urls": {
"Documentation": "https://github.com/zeoses/persian-gender-detection",
"Homepage": "https://github.com/zeoses/persian-gender-detection",
"Source": "https://github.com/zeoses/persian-gender-detection"
},
"split_keywords": [
"persian-gender-detection",
"farsi gender",
"iranian gender",
"name gender",
"persian gender detection",
"gender detection"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "42870cae9880c5af0266c5433c69da5528a2ed014ce23a48e560ad922714c526",
"md5": "ba68861749dc340c28a68cbdf733533e",
"sha256": "45beb42e2d1152068faabe9c33482def34faa69b817ccf67f3c4467d86ce29f1"
},
"downloads": -1,
"filename": "persian_gender_detection-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ba68861749dc340c28a68cbdf733533e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 275511,
"upload_time": "2023-06-14T22:40:15",
"upload_time_iso_8601": "2023-06-14T22:40:15.928068Z",
"url": "https://files.pythonhosted.org/packages/42/87/0cae9880c5af0266c5433c69da5528a2ed014ce23a48e560ad922714c526/persian_gender_detection-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "74f2552c961fff067288c145b3f6a12be6cba31fa200702bbacb1c37df12bacf",
"md5": "ca015e9bf3b326de20481e24fa586277",
"sha256": "a4865dc5a0964379f49ccc3758ff4982df8587ed14790fa7eb901d0de9787b53"
},
"downloads": -1,
"filename": "persian-gender-detection-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "ca015e9bf3b326de20481e24fa586277",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 140182,
"upload_time": "2023-06-14T22:40:20",
"upload_time_iso_8601": "2023-06-14T22:40:20.379514Z",
"url": "https://files.pythonhosted.org/packages/74/f2/552c961fff067288c145b3f6a12be6cba31fa200702bbacb1c37df12bacf/persian-gender-detection-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-14 22:40:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zeoses",
"github_project": "persian-gender-detection",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "persian-gender-detection"
}
JSON
