python示例模板

核心文件说明

main.py

主要入口

log.py

封装日志相关操作

hello_world.py

示例的逻辑代码，可以替换为实际的逻辑

_build.py

编译打包成单个exe文件

_init_venv_and_requirements.py

初始化venv并安装依赖

first_run.py

提供接口判断是否是首次运行

dao.py/data_struct.py

用于自动映射python结构体与dict对象，方便使用各个字段

db.py/db_def.py

提供基于文件的数据存储操作

network.py

封装requests的网络库，适合自己的使用习惯

util.py

从小助手搬过来的一些工具函数

其他文件说明

.github

dependabot.yml

用于自动提示升级版本，会在github上自动提交pr

workflows

包含lint和test相关的workflow定义，会在github action中按配置自动执行

.editorconfig

用于配置一些通用代码风格配置

.gitignore

用于配置git忽略的文件

.pre-commit-config.yaml

配置了flake8、isort、mypy等代码检查工具，目前用于在tox中触发lint

.python-version

定义项目使用的python版本，如果修改为python3.10以外的版本，记得将tox.ini中的python版本也修改

_build.bat

方便一键使用pyinstaller打包的脚本

mypy.ini

用于配置mypy的代码检查工具

requirements.txt

正常运行时的依赖库定义

requirements_dev.txt

本地开发测试时需要的依赖库定义

tox.ini

定义了使用tox运行测试和lint的配置，具体使用方式如下

# test
tox -e py310

# lint
tox -e lint

# all
tox

fzls/python-template