File tree 5 files changed +26
-19
lines changed
5 files changed +26
-19
lines changed Original file line number Diff line number Diff line change 1
1
format : jb-book
2
2
root : index.md
3
3
parts :
4
- - caption : 原则
4
+ - caption : 绪论
5
5
chapters :
6
6
- file : principles/README.md
7
+ - file : init/README.md
8
+ sections :
9
+ - file : init/assets/README.md
10
+ - file : init/procedures/README.md
7
11
- caption : 客户端
8
12
chapters :
9
13
- file : sdk/README.md
Original file line number Diff line number Diff line change
1
+ # 初始化
Original file line number Diff line number Diff line change
1
+ # 项目结构
2
+
3
+ ## 基本结构
4
+
5
+ 文件夹:
6
+ - 代码文件夹:存放正式代码。
7
+ - 示例代码文件夹` examples ` :在编写正式代码前,会先用Jupyter Notebook编写示例代码,以便直观查看使用Pandas等代码的效果。
8
+ - 文档文件夹` docs ` :存放用户文档。
9
+ - 单元测试文件夹` tests ` :存放单元测试,与代码模块一一对应。
10
+ - 集成测试文件夹` integrated_tests ` :存放集成测试,与代码模块一一对应,运行集成测试可对代码进行相关测试。
11
+
12
+ 文件:
13
+ - 配置文件` pyproject.toml ` :Python项目的配置文件,类似于Node的` package.json ` 。
14
+ - 版本日志` CHANGELOG.md ` :在发布版本时记录。
15
+
16
+ ## 代码文件夹
17
+
18
+ - ` __init__.py ` 模块:在Python 3.3之后不是必须的,但推荐保留。可用于存放导入信息,维护导入相关内容,同时符合大家使用Python的习惯。
19
+ - 入口模块` __main__.py ` :若项目以包的形式对外调用,特别是在命令行中使用时,该模块有重要作用。
Original file line number Diff line number Diff line change
1
+ # 初始化流程
Load Diff This file was deleted.
You can’t perform that action at this time.
0 commit comments