https://github.com/bytebaker/indian-names
Python module to generate random names of Indian origin
https://github.com/bytebaker/indian-names
Last synced: about 1 year ago
JSON representation
Python module to generate random names of Indian origin
- Host: GitHub
- URL: https://github.com/bytebaker/indian-names
- Owner: ByteBaker
- License: bsd-3-clause
- Created: 2021-06-11T07:17:49.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-08-21T19:32:34.000Z (almost 5 years ago)
- Last Synced: 2024-10-15T09:14:15.168Z (over 1 year ago)
- Language: Python
- Homepage: https://pypi.org/project/indian-names/
- Size: 33.2 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# indian-names (v0.2)
Python module to generate random names of Indian origin.
    
Installation
------------
You can install it using pip from the repository as:
pip install indian-names
Usage
-----
Indian-names can be used as a command line utility or imported as a Python module.
#### Command Line Usage
To use the script from the command line:
```
$ indian-names
Anand Dubey
```
#### Python Module Usage
Here are examples of all current features:
```
>>> import indian_names
>>> indian_names.get_full_name()
'Nisha Asthana'
>>> indian_names.get_full_name(gender='male')
'Manish Gupta'
>>> indian_names.get_first_name()
'Siddhant'
>>> indian_names.get_first_name(gender='female')
'Kajal'
>>> indian_names.get_last_name()
'Tripathi'
```
The module can currently generate 550+ first names for male and female each, and 350+ last names. Overall 400,000+ full names can be generated.
### TODO (Future):
- Increase the number of names possible.
- Implement first/last name pairs for regional names as well. Emphasis on handling first names that are compatible with only certain last names & vice-versa.
License
-------
This project is released under a [BSD 3-Clause License](https://spdx.org/licenses/BSD-3-Clause.html).
Names are compiled in the following files through various online sources available publically:
- `first.male.names`
- `first.female.names`
- `last.names`