-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added chinese and chinese romanized, preparing for release 1.0.0
- Loading branch information
Showing
21 changed files
with
7,027 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
Metadata-Version: 2.1 | ||
Name: nameCreator | ||
Version: 1.0.0 | ||
Summary: A package to generate names by country | ||
Home-page: https://github.com/JHudd435/nameCreator | ||
Author: Justin Huddleston | ||
Classifier: Programming Language :: Python :: 3 | ||
Classifier: License :: OSI Approved :: Apache Software License | ||
Classifier: Operating System :: Microsoft :: Windows | ||
Requires-Python: >=3.6 | ||
Description-Content-Type: text/markdown | ||
License-File: LICENSE | ||
|
||
# nameCreator | ||
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/JHudd435/nameCreator?style=for-the-badge)](https://github.com/JHudd435/nameCreator/releases/) | ||
[![GitHub forks](https://img.shields.io/github/forks/JHudd435/nameCreator?style=for-the-badge)](https://github.com/JHudd435/nameCreator/network/members) | ||
[![GitHub license](https://img.shields.io/github/license/JHudd435/nameCreator?style=for-the-badge)](https://github.com/JHudd435/nameCreator/blob/main/LICENSE) | ||
[![GitHub issues](https://img.shields.io/github/issues/JHudd435/nameCreator?style=for-the-badge)](https://github.com/JHudd435/nameCreator/issues) | ||
|
||
A python name generator for Windows. | ||
|
||
This is a python package for name generation. It can generate names from different countries, and can generate both male and female names. | ||
Ethnicities: "american", "russian", "spanish", "italian", "german", "french", "swedish", "finnish", "japaneser" (japanese romanized), "japanese", "chineser" (chinese romanized), and "chinese". | ||
|
||
## Installation | ||
|
||
### From pypi | ||
Install from pypi with `pip`: | ||
```shell | ||
pip install nameCreator | ||
``` | ||
|
||
### Build from source | ||
Clone the repository and cd into the nameCreator directory, then: | ||
|
||
```shell | ||
pip install build | ||
python -m build | ||
cd dist | ||
pip install nameCreator-1.0.0-py3-none-any.whl | ||
``` | ||
|
||
## Usage (Only applies when built from source, read the release's corresponding README for that version's usage) | ||
|
||
### In python file | ||
```python | ||
firstNameMale = nameCreator.FirstNameMale('nationality') | ||
|
||
print(firstNameMale) | ||
|
||
lastName = nameCreator.LastName('nationality') | ||
|
||
print(lastName) | ||
|
||
firstNameFemale = nameCreator.FirstNameFemale('nationality') | ||
|
||
print(firstNameFemale) | ||
|
||
lastName = nameCreator.LastName('nationality') | ||
|
||
print(lastName) | ||
``` | ||
|
||
### In command line | ||
|
||
Displays help message: | ||
|
||
```shell | ||
nameCreatorCLI generate --help | ||
``` | ||
|
||
Generates 10 male finnish names: | ||
|
||
```shell | ||
nameCreatorCLI generate -a 10 -e finnish -g m | ||
``` | ||
|
||
Generates 10 italian female names, sends to a text file and does not print the output to the terminal: | ||
|
||
```shell | ||
nameCreatorCLI generate -a 10 -e italian -g f -o italianNames.txt -n | ||
``` | ||
|
||
Arguments: | ||
|
||
Specifies the amount of names to generate: | ||
|
||
```shell | ||
-a --amount | ||
``` | ||
|
||
Specifies the ethnicity: | ||
|
||
```shell | ||
-e --ethnicity | ||
``` | ||
|
||
Specifies the gender of the generated names: | ||
|
||
```shell | ||
-g --gender | ||
``` | ||
|
||
Specifies the output path (like `C:/Users/You/test.txt` or `test.txt` to put in the current path): | ||
|
||
```shell | ||
-o --output | ||
``` | ||
|
||
Specifies whether or not to print the output to the terminal (useless if there is no output path specified): | ||
|
||
```shell | ||
-n --noprint | ||
``` | ||
|
||
## SOURCES: | ||
https://github.com/ironarachne/namegen |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
LICENSE | ||
MANIFEST.in | ||
README.md | ||
nameCreatorCLI.py | ||
pyproject.toml | ||
setup.cfg | ||
src/nameCreator/__init__.py | ||
src/nameCreator.egg-info/PKG-INFO | ||
src/nameCreator.egg-info/SOURCES.txt | ||
src/nameCreator.egg-info/dependency_links.txt | ||
src/nameCreator.egg-info/requires.txt | ||
src/nameCreator.egg-info/top_level.txt | ||
src/nameCreator/F/__init__.py | ||
src/nameCreator/F/firstF.py | ||
src/nameCreator/F/names/american.txt | ||
src/nameCreator/F/names/chinese.txt | ||
src/nameCreator/F/names/chineseR.txt | ||
src/nameCreator/F/names/finnish.txt | ||
src/nameCreator/F/names/french.txt | ||
src/nameCreator/F/names/german.txt | ||
src/nameCreator/F/names/italian.txt | ||
src/nameCreator/F/names/japanese.txt | ||
src/nameCreator/F/names/japaneseR.txt | ||
src/nameCreator/F/names/russian.txt | ||
src/nameCreator/F/names/spanish.txt | ||
src/nameCreator/F/names/swedish.txt | ||
src/nameCreator/L/__init__.py | ||
src/nameCreator/L/last.py | ||
src/nameCreator/L/names/american.txt | ||
src/nameCreator/L/names/chinese.txt | ||
src/nameCreator/L/names/chineseR.txt | ||
src/nameCreator/L/names/finnish.txt | ||
src/nameCreator/L/names/french.txt | ||
src/nameCreator/L/names/german.txt | ||
src/nameCreator/L/names/italian.txt | ||
src/nameCreator/L/names/japanese.txt | ||
src/nameCreator/L/names/japaneseR.txt | ||
src/nameCreator/L/names/russian.txt | ||
src/nameCreator/L/names/spanish.txt | ||
src/nameCreator/L/names/swedish.txt | ||
src/nameCreator/M/__init__.py | ||
src/nameCreator/M/firstM.py | ||
src/nameCreator/M/names/american.txt | ||
src/nameCreator/M/names/chinese.txt | ||
src/nameCreator/M/names/chineseR.txt | ||
src/nameCreator/M/names/finnish.txt | ||
src/nameCreator/M/names/french.txt | ||
src/nameCreator/M/names/german.txt | ||
src/nameCreator/M/names/italian.txt | ||
src/nameCreator/M/names/japanese.txt | ||
src/nameCreator/M/names/japaneseR.txt | ||
src/nameCreator/M/names/russian.txt | ||
src/nameCreator/M/names/spanish.txt | ||
src/nameCreator/M/names/swedish.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
click |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
nameCreator |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,5 +5,5 @@ | |
""" | ||
|
||
__version__ = "0.9.0" | ||
__version__ = "1.0.0" | ||
__author__ = 'Justin Huddleston' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.