getting-started.md

快速上手

本文介绍如何搭建开发环境并开始参与项目开发。

技术栈

类别	工具	版本要求
语言环境	Python	3.12+
UI 框架	Tkinter (Tcl/Tk)	Tcl/Tk 8.6+
包管理	uv	0.13.1+
版本控制	Git	-
IDE	Visual Studio Code 或 PyCharm	PyCharm 2026.1+
任务运行器	Poe the Poet	-
国际化	gettext	-
测试	pytest	-
代码质量	Ruff（格式化 + 检查）、Pyright（类型检查）	-
构建	PyInstaller、InnoSetup、zipapp	-
文档质量	rumdl（格式化 + 检查）	-

项目结构

详见 项目概览。

前置要求

在开始之前，请确保您的系统已安装以下工具：

类别	工具
语言环境	Python
版本控制	Git
包管理	uv
IDE	Visual Studio Code 或 PyCharm

获取源码

git clone https://github.com/hellotool/VCFGeneratorLiteWithTkinter.git
cd VCFGeneratorLiteWithTkinter

或者从 Gitee 克隆（中国大陆用户推荐）：

git clone https://gitee.com/hellotool/VCFGeneratorLiteWithTkinter.git
cd VCFGeneratorLiteWithTkinter

安装依赖

使用 uv 安装项目依赖：

uv sync

该命令会创建虚拟环境并安装所有开发依赖。

常用命令

项目使用 Poe the Poet 作为任务运行器，常用命令如下：

命令	说明
uv run poe test	运行测试
uv run poe format	格式化代码与文档（改写文件）
uv run poe format-check	检查格式（只读）
uv run poe lint	静态检查（Ruff + Pyright + rumdl）
uv run poe lint-fix	修复可自动修复的 lint 问题（不改格式）
uv run poe check	全量只读检查（format-check + lint）
uv run poe fix	修复并验证（lint-fix → format → check）

运行应用

开发模式

uv run python -m vcf_generator_lite

带调试输出

uv run python -m vcf_generator_lite -vv

下一步

• 阅读 项目概览 了解项目架构。