# py-unique-names-generator
Generate unique and memorable name strings
## Prerequisites
Python 3.6 or greater.
## Installation
```sh
$ pip install unique-names-generator
```
## Usage
```python
In [1]: from unique_names_generator import get_random_name
In [2]: get_random_name()
Out[2]: 'Pink Dragon'
```
### Parameters
#### `combo` - List of lists
The package comes with a bunch of random names as lists. By default, we use a `color` and `animal` to generate a random name.
Other lists are `ADJECTIVES`, `ANIMALS`, `COLORS`, `COUNTRIES`, `LANGUAGES`, `NAMES`, `STAR_WARS`.
```python
In [1]: from unique_names_generator import get_random_name
In [2]: from unique_names_generator.data import ADJECTIVES, STAR_WARS
In [3]: get_random_name(combo=[ADJECTIVES, STAR_WARS])
Out[3]: 'Furious Yoda'
```
#### `separator` - A string, default is blank space ` `
```python
In [1]: from unique_names_generator import get_random_name
In [2]: from unique_names_generator.data import ADJECTIVES, NAMES
In [69]: get_random_name(combo=[ADJECTIVES, NAMES], separator="_")
Out[69]: 'Fun_Antonie'
```
#### `style` - A string, one of capital|lowercase|uppercase.
```python
In [1]: from unique_names_generator import get_random_name
In [2]: from unique_names_generator.data import ADJECTIVES, NAMES
In [3]: get_random_name(separator="-", style="lowercase")
Out[3]: 'crimson-cat'
```
And, you can pass your own list of words. But let's face it, then this package would just be a function which randomly chooses a word from a list of strings. So its better to keep adding to the list here or fork it for your own use.
Raw data
{
"_id": null,
"home_page": "https://github.com/ravi-ojha/py-unique-names-generator",
"name": "unique-names-generator",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6.0",
"maintainer_email": "",
"keywords": "",
"author": "Ravi Ojha",
"author_email": "ivarojha@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8a/c7/d30a4d79f7ae47a20543cdfa28613c6405c3c29b03abe120eb8e33294149/unique-names-generator-1.0.2.tar.gz",
"platform": "",
"description": "\n# py-unique-names-generator\nGenerate unique and memorable name strings\n\n\n## Prerequisites\n\nPython 3.6 or greater.\n\n## Installation\n\n```sh\n$ pip install unique-names-generator\n```\n\n## Usage\n\n```python\nIn [1]: from unique_names_generator import get_random_name\n\nIn [2]: get_random_name()\nOut[2]: 'Pink Dragon'\n\n```\n\n### Parameters\n\n#### `combo` - List of lists\n\nThe package comes with a bunch of random names as lists. By default, we use a `color` and `animal` to generate a random name.\nOther lists are `ADJECTIVES`, `ANIMALS`, `COLORS`, `COUNTRIES`, `LANGUAGES`, `NAMES`, `STAR_WARS`.\n\n```python\nIn [1]: from unique_names_generator import get_random_name\nIn [2]: from unique_names_generator.data import ADJECTIVES, STAR_WARS\n\nIn [3]: get_random_name(combo=[ADJECTIVES, STAR_WARS])\nOut[3]: 'Furious Yoda'\n\n```\n\n#### `separator` - A string, default is blank space ` `\n\n\n```python\nIn [1]: from unique_names_generator import get_random_name\nIn [2]: from unique_names_generator.data import ADJECTIVES, NAMES\n\nIn [69]: get_random_name(combo=[ADJECTIVES, NAMES], separator=\"_\")\nOut[69]: 'Fun_Antonie'\n```\n\n#### `style` - A string, one of capital|lowercase|uppercase.\n\n\n```python\nIn [1]: from unique_names_generator import get_random_name\nIn [2]: from unique_names_generator.data import ADJECTIVES, NAMES\n\nIn [3]: get_random_name(separator=\"-\", style=\"lowercase\")\nOut[3]: 'crimson-cat'\n\n```\n\nAnd, you can pass your own list of words. But let's face it, then this package would just be a function which randomly chooses a word from a list of strings. So its better to keep adding to the list here or fork it for your own use.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Generate unique and memorable name strings.",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/ravi-ojha/py-unique-names-generator"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "203ef1a29edc94af8dec3843c1e1fb6e4b7f19e242f36544202b01f3aadf77f8",
"md5": "c0b802f2aa5ff9439db479bec79d6e74",
"sha256": "ea3c7ba5e1d2926e82b183a306bbef924980b007fe7492a8f64b62b052de1b77"
},
"downloads": -1,
"filename": "unique_names_generator-1.0.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "c0b802f2aa5ff9439db479bec79d6e74",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6.0",
"size": 27861,
"upload_time": "2021-09-21T13:39:53",
"upload_time_iso_8601": "2021-09-21T13:39:53.509391Z",
"url": "https://files.pythonhosted.org/packages/20/3e/f1a29edc94af8dec3843c1e1fb6e4b7f19e242f36544202b01f3aadf77f8/unique_names_generator-1.0.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8ac7d30a4d79f7ae47a20543cdfa28613c6405c3c29b03abe120eb8e33294149",
"md5": "464480b52fb3e213f98f420cf9430fcc",
"sha256": "1f8fcc95b27ae5f065b3df8ab62d5e749e9fd383ff7748607e63a10345248e7a"
},
"downloads": -1,
"filename": "unique-names-generator-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "464480b52fb3e213f98f420cf9430fcc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6.0",
"size": 29155,
"upload_time": "2021-09-21T13:39:55",
"upload_time_iso_8601": "2021-09-21T13:39:55.859209Z",
"url": "https://files.pythonhosted.org/packages/8a/c7/d30a4d79f7ae47a20543cdfa28613c6405c3c29b03abe120eb8e33294149/unique-names-generator-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-09-21 13:39:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ravi-ojha",
"github_project": "py-unique-names-generator",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"lcname": "unique-names-generator"
}
JSON
