PiPiName 项目使用教程

1. 项目目录结构及介绍

PiPiName 项目的目录结构如下：

PiPiName/
├── data/
├── LICENSE
├── README.md
├── config.py
├── main.py
├── name.py
├── name_set.py
├── stroke_number.py
└── wuge.py

目录结构介绍

• data/: 存放项目所需的数据文件，如词库、诗文等。
• LICENSE: 项目的开源许可证文件，本项目使用 GPL-3.0 许可证。
• README.md: 项目的说明文档，包含项目的基本介绍、使用方法等。
• config.py: 项目的配置文件，用于设置词库、姓氏、笔画数等参数。
• main.py: 项目的启动文件，运行此文件可以生成符合条件的名字。
• name.py: 处理名字生成的核心逻辑文件。
• name_set.py: 处理名字集合的相关逻辑文件。
• stroke_number.py: 处理笔画数的相关逻辑文件。
• wuge.py: 处理三才五格的相关逻辑文件。

2. 项目的启动文件介绍

main.py

main.py 是 PiPiName 项目的启动文件，运行此文件可以生成符合条件的名字。以下是 main.py 的主要功能介绍：

• 导入模块: 导入所需的模块和配置文件。
• 配置参数: 从 config.py 中读取配置参数，如词库选择、姓氏、笔画数等。
• 生成名字: 根据配置参数生成符合条件的名字，并将结果输出到文件或打印到控制台。

启动方法

在项目根目录下运行以下命令启动项目：

python main.py

3. 项目的配置文件介绍

config.py

config.py 是 PiPiName 项目的配置文件，用于设置词库、姓氏、笔画数等参数。以下是 config.py 的主要配置项介绍：

• name_source: 选择词库，可选值为 0（默认）、1（诗经）、2（楚辞）、3（论语）、4（周易）、5（唐诗）、6（宋诗）、7（宋词）。
• last_name: 设置姓氏，仅支持单姓。
• dislike_words: 设置不想要的字，结果中不会出现这些字。
• min_stroke_count: 设置最小笔画数。
• max_stroke_count: 设置最大笔画数。
• allow_general: 是否允许使用中吉配置的名字。
• name_validate: 是否筛选名字，仅输出名字库中存在的名字。
• gender: 是否筛选性别，可选值为 男、女，空则不筛选。
• check_name: 填入姓名查看三才五格配置，仅支持单姓复名。
• check_name_resource: 是否显示名字来源。

配置示例

# 选择词库
name_source = 0

# 姓氏
last_name = "张"

# 不想要的字
dislike_words = list("")

# 最小笔画数
min_stroke_count = 3

# 最大笔画数
max_stroke_count = 25

# 允许使用中吉
allow_general = False

# 是否筛选名字
name_validate = True

# 是否筛选性别
gender = ""

# 填入姓名查看三才五格配置
check_name = ""

# 是否显示名字来源
check_name_resource = True

通过修改 config.py 中的配置项，可以自定义生成名字的条件和规则。