https://github.com/armanyazdi/persian-names

A Python package for generating random Persian (Farsi) names.
https://github.com/armanyazdi/persian-names

farsi iranian name-generation name-generator persian pypi pypi-package pypi-packages python python-library python3

Last synced: 3 months ago
JSON representation

A Python package for generating random Persian (Farsi) names.

• Host: GitHub
• URL: https://github.com/armanyazdi/persian-names
• Owner: armanyazdi
• License: mit
• Created: 2022-11-15T16:47:15.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-23T15:38:36.000Z (4 months ago)
• Last Synced: 2024-07-23T18:19:37.690Z (4 months ago)
• Topics: farsi, iranian, name-generation, name-generator, persian, pypi, pypi-package, pypi-packages, python, python-library, python3
• Language: Python
• Homepage: https://pypi.org/project/persian-names
• Size: 59.6 KB
• Stars: 17
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# 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).

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).