创建 PyEC 项目
约 488 字大约 2 分钟
2025-12-08
使用 uv 创建项目
uv 是一个比较新的 Python 项目管理工具,它可以帮助我们快速地创建和管理 Python 项目。这里是一个简单的示例:
$ uv init --name pyec --package pyec
$ cd pyec我们来观察一下项目目录结构:
.
├── pyproject.toml
├── .python-version
├── README.md
└── src
└── pyec
└── __init__.py首先,.python-version 文件中包含了项目的 Python 版本信息。这个文件是 uv 创建的,它可以帮助我们确保项目使用正确的 Python 版本接着,我们看一下 pyproject.toml 文件,它包含了项目的配置信息。最后,我们来看一下 src/pyec/__init__.py 文件,它包含了项目的初始化信息。其中只有一个 main() 函数。除了主要的项目结构之外,uv 还额外创建了.git/ 目录,它包含了项目的版本控制信息。
现在,我们来执行一下这个项目,得到下面输出:
$ uv run pyec
$ Hello from pyec!在这个过程中,uv 会做几件事情
- 创建一个
.venv/虚拟环境 - 安装项目依赖
- 运行
.venv/bin/pyec的命令。可以使用source .venv/bin/activate来激活虚拟环境,然后用which pyec来找到pyec可执行文件的路径。 pyec的内容就是调用__init__.py文件中的main()函数。
项目就创建完毕,我们接下去把精力花在添加功能上。等到添加了足够的功能再回来利用 uv 所创建的项目做更多的事情。
添加依赖
我们为项目添加以下依赖:
- ipython:交互式解释器
- pdbpp:比默认的 pdb 调试器更加强大的调试工具
- pre-commit:代码提交前的检查工具,用于检查代码是否符合规范,格式化代码等。配置文件为
.pre-commit-config.yaml - pytest:测试框架,用于编写和运行测试用例,比默认的 unittest 框架更加强大。
