Metadata-Version: 2.1
Name: perseus-name-generator-library
Version: 1.1.0
Summary: Reusable Python components to be shared with some Python projects
Home-page: https://github.com/dcaune/perseus-name-generator-python-library
Author: Daniel CAUNE
Author-email: daniel.caune@gmail.com
License: MIT
Project-URL: Bug Tracker, https://github.com/dcaune/perseus-name-generator-python-library/issues
Project-URL: Documentation, https://github.com/dcaune/perseus-name-generator-python-library
Project-URL: Source Code, https://github.com/dcaune/perseus-name-generator-python-library
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries
Description-Content-Type: text/markdown
Requires-Dist: pipfile
Requires-Dist: perseus-core-library

# Perseus Name Generator Python Library

Wrapper of [Joao HENRIQUES's `name-gen` library](https://github.com/jotaf98/name-gen), a small module to generate names for characters, places, etc.

To install [Perseus Name Generator Python Library](https://github.com/dcaune/perseus-name-generator-python-library), simply enter the follow command line:

```bash
pip install perseus-name-generator
```

For generating names with a specific language, simply get an instance of the word generator for this language and call the method `generate_name`.  For example:

```python
>>> from majormode.utils.namegen import NameGeneratorFactory
>>> name_generator = NameGeneratorFactory.get_instance(NameGeneratorFactory.Language.Japanese)
>>> name_generator.generate_name()
'Ishimmi'
>>> name_generator.generate_name()
'Suita'
>>> name_generator.generate_name()
'Tashirara'
>>> name_generator.generate_name()
'Miyakai'
>>> name_generator.generate_name()
'Miharadase'
```


