semvec/pypi-packages huggingface dataset:
bbyu-nickname-generator 0.16
bbyu-nickname-generator
Requires Python: >=3
Keywords: nickname,name,generator,nickname generator,bbyu

# bbyu-nickname-generator

Generate nickname with various options(animal, color etc.)

Currently supports only korean. but have plans to add all of the language in the world

### Objects

* adjective
* animal
* color

## Install
```shell
pip install bbyu-nickname-generator
```

## Usage
```python
>> from bbyu import generator
>> print(generator.easy_generate())
>> '수다스러운도마뱀'
>> print(generator.generate(max_length=12, number_length=3, seperator='-'))
>> '뒤늦은-물개-234'
>> print(generator.generate(max_length=10, number_length=2)) # default seperator = None
>> '외로운원숭이28'
>> generate(max_length=10, number_length=2, items=['number', '번째', 'color', 'animal'])
>> '72번째분홍색문어'
```

* Find out test.py for basic use case.

## Setting

### easy_generate()
```
generator.easy_generate()
```
* = ``generate(max_length=15, number_length=0))``

### generate()
```python
generator.generate(max_length=12, number_length=3, items=['color', 'animal', 'number'], seperator='-')
```
* ``max_length`` : The maximum length of nickname. It's easy to limit length of field.
* ``number_length`` : The length of number which locates end of the nickname.
* ``item`` : List of item type. item is the object which you can put in nickname. If you don't set any sequence, default is ``['adjective', 'number']``.

  * item list : ``'color', 'animal', 'number'``

  * else : except above item name, generator understand it's plain text. So they just put it to all nicknames. ex) '73``th``_red_mouse', '42``th``_green_horse'

* ``seperator`` : The seperator which shows up in between two item(adj, color, animal etc).