persian-names


Namepersian-names JSON
Version 1.4.0 PyPI version JSON
download
home_pagehttps://github.com/armanyazdi/persian-names
SummaryA Python library for generating random Persian (Farsi) names.
upload_time2023-09-10 21:08:25
maintainer
docs_urlNone
authorArman Yazdi
requires_python
licenseMIT
keywords persian names farsi names iranian names name generator
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # persian-names

[![PyPI](https://img.shields.io/pypi/v/persian-names?style=for-the-badge)](https://pypi.org/project/persian-names)
[![GitHub](https://img.shields.io/github/license/armanyazdi/persian-names?style=for-the-badge)](https://pypi.org/project/persian-names)

A Python library 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).

## 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
```

### 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
```

## 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": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "persian names,farsi names,iranian names,name generator",
    "author": "Arman Yazdi",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/d3/8a/bb7bca3140c095f025c01fda61e93c16239af36e5089769c760f10e77f4b/persian-names-1.4.0.tar.gz",
    "platform": null,
    "description": "# persian-names\n\n[![PyPI](https://img.shields.io/pypi/v/persian-names?style=for-the-badge)](https://pypi.org/project/persian-names)\n[![GitHub](https://img.shields.io/github/license/armanyazdi/persian-names?style=for-the-badge)](https://pypi.org/project/persian-names)\n\nA Python library 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\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\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\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## 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 library for generating random Persian (Farsi) names.",
    "version": "1.4.0",
    "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": "694f19347ed890ff90d804c8a00996cef1b8a299a94ccc7050a8853ea352e099",
                "md5": "596923857b23e3886acd88110656ff0f",
                "sha256": "51d0634e30035197aeb3d02be3dccc9c9e8c71616ecf371c531cdc6de4de2bb7"
            },
            "downloads": -1,
            "filename": "persian_names-1.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "596923857b23e3886acd88110656ff0f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 17610,
            "upload_time": "2023-09-10T21:08:23",
            "upload_time_iso_8601": "2023-09-10T21:08:23.569280Z",
            "url": "https://files.pythonhosted.org/packages/69/4f/19347ed890ff90d804c8a00996cef1b8a299a94ccc7050a8853ea352e099/persian_names-1.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d38abb7bca3140c095f025c01fda61e93c16239af36e5089769c760f10e77f4b",
                "md5": "7c86e45e8829f05435deb528de26abd7",
                "sha256": "f15936775b474e12e07e5a5425bf55ccba4f1bc35f4ca427150acd696bc4d3e6"
            },
            "downloads": -1,
            "filename": "persian-names-1.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7c86e45e8829f05435deb528de26abd7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 11184,
            "upload_time": "2023-09-10T21:08:25",
            "upload_time_iso_8601": "2023-09-10T21:08:25.789254Z",
            "url": "https://files.pythonhosted.org/packages/d3/8a/bb7bca3140c095f025c01fda61e93c16239af36e5089769c760f10e77f4b/persian-names-1.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-10 21:08:25",
    "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"
}
        
Elapsed time: 0.12499s