Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bbaovanc/libnamegen

Generate silly names such as MrEarmuffsifier742! CLI: https://pypi.org/project/pynamegen/
https://github.com/bbaovanc/libnamegen

name-generation name-generator namegenerator pip pip3 pypi pypi-package pypi-source python python-3 python-3-6 python-3-7 python-3-8 python-library python3 python36 python37 python38

Last synced: 3 days ago
JSON representation

Generate silly names such as MrEarmuffsifier742! CLI: https://pypi.org/project/pynamegen/

Awesome Lists containing this project

README

        

# libnamegen

[![Build Status](https://drone.bbaovanc.com/api/badges/bbaovanc/libnamegen/status.svg)](https://drone.bbaovanc.com/bbaovanc/libnamegen)

![PyPI](https://img.shields.io/pypi/v/libnamegen)
![PyPI - License](https://img.shields.io/pypi/l/libnamegen)

Package containing various name generation methods. Originally on my [NameGenerator](https://github.com/BBaoVanC/NameGenerator) project.

## Features

* Easy to use
* Imported as module
* Always tested before release
* Officially supports latest two versions of Python 3

---

## How to Install

Run the command `pip install libnamegen`. If you want to specify a specific Python version to use for pip, use a command such as `pip3` or `pip3.8`.

libnamegen requires the package [libprogress](https://pypi.org/project/libprogress/), but it will automatically be installed by pip.

---

## Documentation

### API

Generate one classic name without debug:

``` python
from libnamegen import classic

# this uses the defaults which are one name, debug disabled, and classic generator
print(classic.gen())
```

Generate seven classic names with debug:

``` python
from libnamegen import classic

print(classic.gen(count=7, debug=True))
# print(classic.gen(7, True)) # also valid
```

Prompt the user for the amount of names, enable debug, and generate classic names:

``` python
from libnamegen import classic

amt = input("Amount of names to generate >> ")
count = int(amt)

names = classic.gen(count, true)
for name in names:
print(name)
```

Generate one random name without debug:

``` python
from libnamegen import random

print(random.gen())
```

Generate one name using the random method 15 characters long:

``` python
from libnamegen import random

print(random.gen(length=15))
```

You can also import the entire libnamegen package, which will import all generation methods:

``` python
import libnamegen

print(libnamegen.classic.gen())
```

---

## License

_libnamegen_ is licensed under the GPLv3 license. For more information, please refer to [`LICENSE`](https://git.bbaovanc.com/bbaovanc/libnamegen/src/branch/master/LICENSE).