Metadata-Version: 2.1
Name: persian-names
Version: 1.0.3
Summary: A simple Python library for generating random Persian (Farsi) names.
Home-page: https://github.com/armanyazdi/persian-names
Author: Arman Yazdi
License: MIT
Project-URL: Documentation, https://pypi.org/project/persian-names
Project-URL: Source, https://github.com/armanyazdi/persian-names
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/markdown
License-File: LICENSE

# persian-names

A simple Python library for generating random Persian (Farsi) names.

# Installation

`pip install persian-names`

# Usage

Let's take a look at what an example test case would look like using `persian-names`.


To generate a Persian name in English:

```python
import persian_names as pn

pn.fullname_en('male')
pn.fullname_en('female')
pn.fullname_en('random')
```

To generate a Persian name in Farsi:

```python
import persian_names as pn

pn.fullname_fa('male')
pn.fullname_fa('female')
pn.fullname_fa('random')
```


