Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xinz/chinese_name
https://github.com/xinz/chinese_name
Last synced: 15 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/xinz/chinese_name
- Owner: xinz
- License: mit
- Created: 2021-12-21T03:08:31.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-29T07:12:48.000Z (over 2 years ago)
- Last Synced: 2024-12-21T14:07:47.558Z (17 days ago)
- Language: HTML
- Size: 104 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ChineseName
A simple tool built-in dataset for processing Chinese name, to get the surname, the given name, or both from the valid Chinese name input.
The surnames dataset are merged from:
* [Baidu Baike - 中华姓氏大全](https://baike.baidu.com/item/%E4%B8%AD%E5%8D%8E%E5%A7%93%E6%B0%8F%E5%A4%A7%E5%85%A8/1689641)
* [wainshine/Chinese-Names-Corpus](https://github.com/wainshine/Chinese-Names-Corpus/tree/master/Chinese_Names_Corpus/Chinese_Family_Name（1k）.xlsx )
## Usage
This library uses pattern match to find the matched surname or others in the precompiled modules, here are some examples:
```
iex(1)> ChineseName.surname("李四")
"李"
iex(2)> ChineseName.given_name("李四")
"四"
iex(3)> ChineseName.split("李四")
{"李", "四"}
```
If input an invalid or not-included name in the dataset surnames, return `nil` or the original input string:
```
iex(5)> ChineseName.surname("测试")
nil
iex(6)> ChineseName.given_name("测试")
nil
iex(7)> ChineseName.split("测试")
"测试"
```
Please see the document of the main module `ChineseName` for details.
## Development
Since this library uses [floki](https://hex.pm/packages/floki) with [html5ever](https://hex.pm/packages/html5ever) parser to parse the HTML page of [Baidu Baike - 中华姓氏大全](https://baike.baidu.com/item/%E4%B8%AD%E5%8D%8E%E5%A7%93%E6%B0%8F%E5%A4%A7%E5%85%A8/1689641), the Rust compiler [installed](https://www.rust-lang.org/tools/install) is required.
After the mix dependences installed, run `mix generate_parser` you will see the following output:
```
Successfully download dataset from: `https://baike.baidu.com/item/中华姓氏大全/1689641` will be merged with datasource from `priv/data/Chinese_Family_Name.xlsx`
* creating lib/generated/given_name.ex
* creating lib/generated/surname.ex
* creating lib/generated/break.ex
```
As usual, only need to follow the above steps to initialize, update dataset(if needed) or the original web page content change caused a fixing to the dataset processing.
Currently, the `priv/data/Chinese_Family_Name.xlsx` file is a copy from [wainshine/Chinese-Names-Corpus](https://github.com/wainshine/Chinese-Names-Corpus) in this repo.
## Test
Run `mix test`
## You should know
Due to some Chinese characters naming may overlap, this library is no guarantee to 100% give the correct match, for example, both "万俟"(mò qí) and "万"(wàn)
are valid Chinese surnames, the implement of this library make the longer string of the surname character(s) in a higher pattern match priority, so if input a name as "万俟咏", it will process "万俟" as the surname, not "万".
> "万俟" is a double-character surname, is a typical ethnic minority surname.
> "万" is one of the hundred surnames in China, is a classic and common Chinese surname.