# persian-names
[](https://pypi.org/project/persian-names)
[](https://pypi.org/project/persian-names)
A Python package for generating random Persian (Farsi) names.
This package generates frequently logical names
(a mix of popular Persian and Arabic names with common Persian family name suffixes).
Note: `persian-names` generates **90,000,000** unique full names (As Iran population in 2024) in less than 3 minutes.
## Installation
Install from [PyPI](https://pypi.org/project/persian-names) with pip by typing in your favorite terminal:
`pip install persian-names`
## Usage
Let's take a look at what an example test case would look like using `persian-names`.
### Generate Persian Full Names in Farsi:
```python
from persian_names import fullname_fa
fullname_fa('male') # or fullname_fa('m')
fullname_fa('female') # or fullname_fa('f')
fullname_fa('random') # or fullname_fa('r')
```
#### Example:
```python
from persian_names import fullname_fa
print(fullname_fa('m')) # اشکان محمدرضائیان
print(fullname_fa('f')) # مهسا امیری تهرانی
print(fullname_fa('r')) # بیتا خسروی راد
```
### Generate Persian Full Names in English:
```python
from persian_names import fullname_en
fullname_en('male') # or fullname_en('m')
fullname_en('female') # or fullname_en('f')
fullname_en('random') # or fullname_en('r')
```
#### Example:
```python
from persian_names import fullname_en
print(fullname_en('m')) # Arsalan Mohammadi
print(fullname_en('f')) # Sara Alipour
print(fullname_en('r')) # Danial Ferdosi Khorasani
```
### Generate First Names and Last Names in Farsi:
```python
from persian_names import *
# First Name
firstname_fa('male') # or firstname_fa('m')
firstname_fa('female') # or firstname_fa('f')
firstname_fa('random') # or firstname_fa('r')
# Last Name
lastname_fa()
```
#### Example:
```python
from persian_names import *
print(firstname_fa('m')) # آرمان
print(firstname_fa('f')) # ساحل
print(firstname_fa('r')) # علیرضا
print(lastname_fa()) # شیخ اسماعیلی
```
### Generate First Names and Last Names in English:
```python
from persian_names import *
# First Name
firstname_en('male') # or firstname_en('m')
firstname_en('female') # or firstname_en('f')
firstname_en('random') # or firstname_en('r')
# Last Name
lastname_en()
```
#### Example:
```python
from persian_names import *
print(firstname_en('m')) # Mehrad
print(firstname_en('f')) # Darya
print(firstname_en('r')) # Baran
print(lastname_en()) # Bakhtiarizadeh
```
## Issues
Feel free to submit issues and enhancement requests.
## Contributing
Feel free to contribute names database with your kindly pull requests.
## License
`persian-names` is available under the [MIT license](https://github.com/armanyazdi/persian-names/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/armanyazdi/persian-names",
"name": "persian-names",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "persian names, farsi names, iranian names, name generator",
"author": "Arman Yazdi",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/72/6a/811a754764deaa3fb6deed9127346b110fd88cf4c6830026830c1d673c36/persian-names-1.5.1.tar.gz",
"platform": null,
"description": "# persian-names\n\n[](https://pypi.org/project/persian-names)\n[](https://pypi.org/project/persian-names)\n\nA Python package for generating random Persian (Farsi) names.\n\nThis package generates frequently logical names \n(a mix of popular Persian and Arabic names with common Persian family name suffixes).\n\nNote: `persian-names` generates **90,000,000** unique full names (As Iran population in 2024) in less than 3 minutes.\n\n## Installation\n\nInstall from [PyPI](https://pypi.org/project/persian-names) with pip by typing in your favorite terminal:\n\n`pip install persian-names`\n\n## Usage\n\nLet's take a look at what an example test case would look like using `persian-names`.\n\n### Generate Persian Full Names in Farsi:\n\n```python\nfrom persian_names import fullname_fa\n\nfullname_fa('male') # or fullname_fa('m')\nfullname_fa('female') # or fullname_fa('f')\nfullname_fa('random') # or fullname_fa('r')\n```\n\n#### Example:\n\n```python\nfrom persian_names import fullname_fa\n\nprint(fullname_fa('m')) # \u0627\u0634\u06a9\u0627\u0646 \u0645\u062d\u0645\u062f\u0631\u0636\u0627\u0626\u06cc\u0627\u0646\nprint(fullname_fa('f')) # \u0645\u0647\u0633\u0627 \u0627\u0645\u06cc\u0631\u06cc \u062a\u0647\u0631\u0627\u0646\u06cc\nprint(fullname_fa('r')) # \u0628\u06cc\u062a\u0627 \u062e\u0633\u0631\u0648\u06cc \u0631\u0627\u062f\n```\n\n### Generate Persian Full Names in English:\n\n```python\nfrom persian_names import fullname_en\n\nfullname_en('male') # or fullname_en('m')\nfullname_en('female') # or fullname_en('f')\nfullname_en('random') # or fullname_en('r')\n```\n\n#### Example:\n\n```python\nfrom persian_names import fullname_en\n\nprint(fullname_en('m')) # Arsalan Mohammadi\nprint(fullname_en('f')) # Sara Alipour\nprint(fullname_en('r')) # Danial Ferdosi Khorasani\n```\n\n### Generate First Names and Last Names in Farsi:\n\n```python\nfrom persian_names import *\n\n# First Name\nfirstname_fa('male') # or firstname_fa('m')\nfirstname_fa('female') # or firstname_fa('f')\nfirstname_fa('random') # or firstname_fa('r')\n\n# Last Name\nlastname_fa()\n```\n\n#### Example:\n\n```python\nfrom persian_names import *\n\nprint(firstname_fa('m')) # \u0622\u0631\u0645\u0627\u0646\nprint(firstname_fa('f')) # \u0633\u0627\u062d\u0644\nprint(firstname_fa('r')) # \u0639\u0644\u06cc\u0631\u0636\u0627\nprint(lastname_fa()) # \u0634\u06cc\u062e \u0627\u0633\u0645\u0627\u0639\u06cc\u0644\u06cc\n```\n\n### Generate First Names and Last Names in English:\n\n```python\nfrom persian_names import *\n\n# First Name\nfirstname_en('male') # or firstname_en('m')\nfirstname_en('female') # or firstname_en('f')\nfirstname_en('random') # or firstname_en('r')\n\n# Last Name\nlastname_en()\n```\n\n#### Example:\n\n```python\nfrom persian_names import *\n\nprint(firstname_en('m')) # Mehrad\nprint(firstname_en('f')) # Darya\nprint(firstname_en('r')) # Baran\nprint(lastname_en()) # Bakhtiarizadeh\n```\n\n## Issues\n\nFeel free to submit issues and enhancement requests.\n\n## Contributing\n\nFeel free to contribute names database with your kindly pull requests.\n\n## License\n\n`persian-names` is available under the [MIT license](https://github.com/armanyazdi/persian-names/blob/main/LICENSE).\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python package for generating random Persian (Farsi) names.",
"version": "1.5.1",
"project_urls": {
"Documentation": "https://pypi.org/project/persian-names",
"Homepage": "https://github.com/armanyazdi/persian-names",
"Source": "https://github.com/armanyazdi/persian-names"
},
"split_keywords": [
"persian names",
" farsi names",
" iranian names",
" name generator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e72eed2630cf772a2ff663dd2271221e35082826414525a4609c3bff3d6377bf",
"md5": "9a27b84a03a5a2799687d6a3678b57e1",
"sha256": "412202569e0e99046e312612aaa8055d925c5270ba196a4688f4027b1c12f0aa"
},
"downloads": -1,
"filename": "persian_names-1.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a27b84a03a5a2799687d6a3678b57e1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 22459,
"upload_time": "2024-08-21T09:14:10",
"upload_time_iso_8601": "2024-08-21T09:14:10.367194Z",
"url": "https://files.pythonhosted.org/packages/e7/2e/ed2630cf772a2ff663dd2271221e35082826414525a4609c3bff3d6377bf/persian_names-1.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "726a811a754764deaa3fb6deed9127346b110fd88cf4c6830026830c1d673c36",
"md5": "99232da17499fb181447df6b5a155099",
"sha256": "1a1e7636cbcfffe6ba83c432a9aca49b6ebcb7bc9d7a7c788bfc0fa46db87ad7"
},
"downloads": -1,
"filename": "persian-names-1.5.1.tar.gz",
"has_sig": false,
"md5_digest": "99232da17499fb181447df6b5a155099",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13897,
"upload_time": "2024-08-21T09:14:12",
"upload_time_iso_8601": "2024-08-21T09:14:12.186142Z",
"url": "https://files.pythonhosted.org/packages/72/6a/811a754764deaa3fb6deed9127346b110fd88cf4c6830026830c1d673c36/persian-names-1.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-21 09:14:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "armanyazdi",
"github_project": "persian-names",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "persian-names"
}
JSON
