go-gimei
This project is a golang port of Ruby's gimei. Import as library or use as CLI.
go-gimei generates fake data that people's name and address in Japanese and supports furigana phonetic renderings of kanji.
The project name comes from Japanese '偽名' means a false name.
Usage
package main
import (
"fmt"
"github.com/mattn/go-gimei"
)
func main() {
name := gimei.NewName()
fmt.Println(name) // 斎藤 陽菜
fmt.Println(name.Kanji()) // 斎藤 陽菜
fmt.Println(name.Hiragana()) // さいとう はるな
fmt.Println(name.Katakana()) // サイトウ ハルナ
fmt.Println(name.Romaji()) // Haruna Saito
fmt.Println(name.Last.Kanji()) // 斎藤
fmt.Println(name.Last.Hiragana()) // さいとう
fmt.Println(name.Last.Katakana()) // サイトウ
fmt.Println(name.Last.Romaji()) // Saito
fmt.Println(name.First.Kanji()) // 陽菜
fmt.Println(name.First.Hiragana()) // はるな
fmt.Println(name.First.Katakana()) // ハルナ
fmt.Println(name.First.Romaji()) // Haruna
fmt.Println(name.Sex) // 女
fmt.Println(name.IsMale()) // false
male := gimei.NewMale()
fmt.Println(male) // 小林 顕士
fmt.Println(male.IsMale()) // true
fmt.Println(male.IsFemale()) // false
address := gimei.NewAddress()
fmt.Println(address) // 岡山県大島郡大和村稲木町
fmt.Println(address.Kanji()) // 岡山県大島郡大和村稲木町
fmt.Println(address.Hiragana()) // おかやまけんおおしまぐんやまとそんいなぎちょう
fmt.Println(address.Katakana()) // オカヤマケンオオシマグンヤマトソンイナギチョウ
fmt.Println(address.Prefecture) // 岡山県
fmt.Println(address.Prefecture.Kanji()) // 岡山県
fmt.Println(address.Prefecture.Hiragana()) // おかやまけん
fmt.Println(address.Prefecture.Katakana()) // オカヤマケン
fmt.Println(address.City) // 大島郡大和村
fmt.Println(address.City.Kanji()) // 大島郡大和村
fmt.Println(address.City.Hiragana()) // おおしまぐんやまとそん
fmt.Println(address.City.Katakana()) // オオシマグンヤマトソン
fmt.Println(address.Town) // 稲木町
fmt.Println(address.Town.Kanji()) // 稲木町
fmt.Println(address.Town.Hiragana()) // いなぎちょう
fmt.Println(address.Town.Katakana()) // イナギチョウ
prefecture := gimei.NewPrefecture()
fmt.Println(prefecture) // 青森県
}Deterministic Random
go-gimei supports seeding of its pseudo-random number generator to provide deterministic output of repeated method calls.
import "math/rand"
gimei.SetRandom(rand.New(rand.NewSource(42)))
fmt.Println(gimei.NewName()) // 前川 永麻
fmt.Println(gimei.NewAddress()) // 佐賀県斜里郡斜里町浄法寺町樋口
gimei.SetRandom(rand.New(rand.NewSource(42)))
fmt.Println(gimei.NewName()) // 前川 永麻
fmt.Println(gimei.NewAddress()) // 佐賀県斜里郡斜里町浄法寺町樋口CLI Usage
$ gimei [OPTIONS] [ARGS]Omitting ARGS is equivalent to specifying name:kanji.
OPTIONS
-sep string
specify string used to separate fields(default: ", ").
-n number
display number record(s).
-count
display records read from embedded yaml files and exit.
-h, -help
display usage and exit.
ARGS
Argument for a personal name:
name|male|female[:NAME_DISPLAY_OPTION]
NAME_DISPLAY_OPTION list
to display full name:
'kanji', (is equivalent to omitting NAME_DISPLAY_OPTION)
'hiragana',
'katakana',
'romaji'
to display last name:
'last-kanji',
'last-hiragana',
'last-katakana',
'last-romaji'
to display first name:
'first-kanji',
'first-hiragana',
'first-katakana',
'first-romaji'
to display which it is male/female:
'is-male',
'is-female'
Argument for an address:
address[:ADDRESS_DISPLAY_OPTION]
ADDRESS_DISPLAY_OPTION list
to display address:
'kanji', (is eqivalent ot omitting ADDRESS_DISPLAY_OPTION)
'hiragana',
'katakana'
to display prefecture:
'prefecture-kanji',
'prefecture-hiragana',
'prefecture-katakana'
to display city:
'city-kanji',
'city-hiragana',
'city-katakana'
to display town:
'town-kanji',
'town-hiragana',
'town-katakana'
EXAMPLES
$ gimei
古賀 正浩
$ gimei name:kanji name:katakana
中村 紳一, ナカムラ シンイチ
$ gimei -sep '/' address:prefecture-kanji address:town-kanji
滋賀県/田所町
$ gimei -n 3 name name:hiragana
白川 彰花, しらかわ あきか
関根 勇一, せきね ゆういち
大場 星良, おおば きららRequirements
golang
Installation
Install the library.
$ go get github.com/mattn/go-gimei
CLI installation
On Go version 1.16 or later, this command works:
$ go install github.com/mattn/go-gimei/cmd/gimei@latestRunning Tests
To run all the tests, do:
$ go testLicense
MIT
Dictionary YAML file is generated from naist-jdic.
Author
Yasuhiro Matsumoto (a.k.a mattn)