# Username Generator 🧙♂️
Generate unique and catchy usernames based on different styles and themes with the `username_generator` package.
## 🚀 Installation
Install the package using pip:
```bash
pip install name_gen_tool
```
## 🎯 Features
- **Variety of Styles:** Choose from a wide range of styles like Professional, Nature-Inspired, Artistic, and more!
- **Customizable Patterns:** Combine nouns, adjectives, keywords, and numbers to create unique patterns.
- **Prefix & Suffix Support:** Add an additional touch with custom or random prefixes/suffixes.
## 🎨 Available Styles
- **Professional**
- **Nature-Inspired**
- **Artistic**
- **Aesthetic**
- **Fantasy**
- **Crazy**
- **Cool**
- **Sporty**
- **Cute**
- **Tech-Inspired**
- **Sci-Fi**
- **Funny**
- **Gamer**
...and more coming soon!
Absolutely! Let's expand on the usage section, including examples for each of the options and their explanations:
---
## 🔧 Usage
To generate usernames using the package, start by importing the necessary modules:
```python
from username_generator import generateUsernames, Styles
```
### Basic Usage
Simply pass a keyword to generate usernames:
```python
usernames = generateUsernames('JohnDoe')
print(usernames)
```
### Specify a Style
You can specify a style from the available styles. For example, to generate nature-inspired usernames:
```python
styledUsernames = generateUsernames('JohnDoe', {'style': Styles.NATURE_INSPIRED})
print(styledUsernames)
```
### Using Lucky Numbers
Add a favorite or lucky number that will be used in the generated usernames:
```python
luckyNumberUsernames = generateUsernames('JaneDoe', {'luckyNumber': 7})
print(luckyNumberUsernames)
```
### Adding Prefixes and Suffixes
Customize your usernames with prefixes and suffixes:
```python
prefixedUsernames = generateUsernames('Eva', {'prefix': 'Queen'})
print(prefixedUsernames)
suffixedUsernames = generateUsernames('Eva', {'suffix': 'TheGreat'})
print(suffixedUsernames)
```
You can also let the generator choose a random prefix for you:
```python
randomPrefixedUsernames = generateUsernames('Eva', {'prefix': True})
print(randomPrefixedUsernames)
```
### Options Explained
- **style (optional):** A string that specifies the style you want for the generated username. If not provided, a style will be randomly chosen.
- **luckyNumber (optional):** A number that will be used in the generated usernames. If not provided, a random number will be used.
- **prefix (optional):** A string that will be used as a prefix in the generated usernames. If set to `True`, a random prefix will be chosen. If not provided, no prefix will be used.
- **suffix (optional):** A string that will be used as a suffix in the generated usernames. If not provided, no suffix will be used.
---
## 📜 License
This project is licensed under the MIT License. See the `LICENSE` file for more details.
## 🌐 Official Website
Please visit [UsernameGenerator.IO](https://usernamegenerator.io/) for more advanced options and tools to make your username looks stunning.
Raw data
{
"_id": null,
"home_page": "https://github.com/bellamy-blakee/username-generator-tool",
"name": "name-gen-tool",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "username generator,instagram username generator,social media name generator",
"author": "Bellamy",
"author_email": "bellamyy.blakee100@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e2/de/cbe51bcadd2c9dffcd89e71d36fa29f3a05fc7b402c8a33ab0c915f7fd3c/name_gen_tool-0.1.1.tar.gz",
"platform": null,
"description": "# Username Generator \ud83e\uddd9\u200d\u2642\ufe0f\n\nGenerate unique and catchy usernames based on different styles and themes with the `username_generator` package.\n\n## \ud83d\ude80 Installation\n\nInstall the package using pip:\n\n```bash\npip install name_gen_tool\n```\n\n## \ud83c\udfaf Features\n\n- **Variety of Styles:** Choose from a wide range of styles like Professional, Nature-Inspired, Artistic, and more!\n- **Customizable Patterns:** Combine nouns, adjectives, keywords, and numbers to create unique patterns.\n- **Prefix & Suffix Support:** Add an additional touch with custom or random prefixes/suffixes.\n\n## \ud83c\udfa8 Available Styles\n\n- **Professional**\n- **Nature-Inspired**\n- **Artistic**\n- **Aesthetic**\n- **Fantasy**\n- **Crazy**\n- **Cool**\n- **Sporty**\n- **Cute**\n- **Tech-Inspired**\n- **Sci-Fi**\n- **Funny**\n- **Gamer**\n \n...and more coming soon!\n\nAbsolutely! Let's expand on the usage section, including examples for each of the options and their explanations:\n\n---\n\n## \ud83d\udd27 Usage\n\nTo generate usernames using the package, start by importing the necessary modules:\n\n```python\nfrom username_generator import generateUsernames, Styles\n```\n\n### Basic Usage\n\nSimply pass a keyword to generate usernames:\n\n```python\nusernames = generateUsernames('JohnDoe')\nprint(usernames)\n```\n\n### Specify a Style\n\nYou can specify a style from the available styles. For example, to generate nature-inspired usernames:\n\n```python\nstyledUsernames = generateUsernames('JohnDoe', {'style': Styles.NATURE_INSPIRED})\nprint(styledUsernames)\n```\n\n### Using Lucky Numbers\n\nAdd a favorite or lucky number that will be used in the generated usernames:\n\n```python\nluckyNumberUsernames = generateUsernames('JaneDoe', {'luckyNumber': 7})\nprint(luckyNumberUsernames)\n```\n\n### Adding Prefixes and Suffixes\n\nCustomize your usernames with prefixes and suffixes:\n\n```python\nprefixedUsernames = generateUsernames('Eva', {'prefix': 'Queen'})\nprint(prefixedUsernames)\n\nsuffixedUsernames = generateUsernames('Eva', {'suffix': 'TheGreat'})\nprint(suffixedUsernames)\n```\n\nYou can also let the generator choose a random prefix for you:\n\n```python\nrandomPrefixedUsernames = generateUsernames('Eva', {'prefix': True})\nprint(randomPrefixedUsernames)\n```\n\n### Options Explained\n\n- **style (optional):** A string that specifies the style you want for the generated username. If not provided, a style will be randomly chosen.\n \n- **luckyNumber (optional):** A number that will be used in the generated usernames. If not provided, a random number will be used.\n \n- **prefix (optional):** A string that will be used as a prefix in the generated usernames. If set to `True`, a random prefix will be chosen. If not provided, no prefix will be used.\n\n- **suffix (optional):** A string that will be used as a suffix in the generated usernames. If not provided, no suffix will be used.\n\n---\n\n\n## \ud83d\udcdc License\n\nThis project is licensed under the MIT License. See the `LICENSE` file for more details.\n\n## \ud83c\udf10 Official Website\n\nPlease visit [UsernameGenerator.IO](https://usernamegenerator.io/) for more advanced options and tools to make your username looks stunning.\n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A package to generate user names based on styles.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/bellamy-blakee/username-generator-tool"
},
"split_keywords": [
"username generator",
"instagram username generator",
"social media name generator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "79a29bdde928c16f73dc42c106bc286548edd3ccb8c5bbf978acc853e9e322fc",
"md5": "39dbd98a382e48903b4ffbfa928cef34",
"sha256": "bd571f1a916beae82a6f91c73d4c6e343e9cb7d506f3fba7a96e1a618b2353c5"
},
"downloads": -1,
"filename": "name_gen_tool-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "39dbd98a382e48903b4ffbfa928cef34",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 2379,
"upload_time": "2023-10-15T08:33:54",
"upload_time_iso_8601": "2023-10-15T08:33:54.059144Z",
"url": "https://files.pythonhosted.org/packages/79/a2/9bdde928c16f73dc42c106bc286548edd3ccb8c5bbf978acc853e9e322fc/name_gen_tool-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e2decbe51bcadd2c9dffcd89e71d36fa29f3a05fc7b402c8a33ab0c915f7fd3c",
"md5": "4d1cf9b82036a33af7a14db429a58562",
"sha256": "9895b17b0765c4f83b79629bbbe37fdb176e150f7cd1de8bde300363c98a9c54"
},
"downloads": -1,
"filename": "name_gen_tool-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "4d1cf9b82036a33af7a14db429a58562",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2364,
"upload_time": "2023-10-15T08:33:56",
"upload_time_iso_8601": "2023-10-15T08:33:56.191310Z",
"url": "https://files.pythonhosted.org/packages/e2/de/cbe51bcadd2c9dffcd89e71d36fa29f3a05fc7b402c8a33ab0c915f7fd3c/name_gen_tool-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-15 08:33:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bellamy-blakee",
"github_project": "username-generator-tool",
"github_not_found": true,
"lcname": "name-gen-tool"
}
JSON
