Metadata-Version: 2.1
Name: indian-names
Version: 0.1
Summary: Generate random names of Indian origin
Home-page: https://github.com/ByteBaker/indian-names
Author: Shraddha Kishan Tripathi
License: BSD 3-Clause License
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# indian-names
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()
    'Bhawana Joshi'
    >>> 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 400+ first names each for male and female, and 200+ last names. Overall 200,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`


