Python-UV 项目使用教程

Python-UV 项目使用教程

python-uv This repository contains configurations to set up a Python development environment using VSCode's Dev Container feature. The environment includes uv and Ruff. 项目地址: https://gitcode.com/gh_mirrors/py/python-uv

1. 项目目录结构及介绍

本项目是基于VSCode的Dev Container特性构建的Python开发环境。以下是项目的目录结构及其简要说明：

python-uv/
├── .devcontainer/          # Dev Container 配置目录
│   ├── devcontainer.json   # Dev Container 配置文件
│   └── Dockerfile          # Dockerfile 配置
├── .github/                # GitHub Actions 工作流目录
│   ├── actions/            # GitHub Actions 自定义动作
│   ├── workflows/          # GitHub Actions 工作流文件
├── .vscode/                # VSCode 设置目录
│   ├── extensions.json     # VSCode 扩展配置
│   └── settings.json       # VSCode 设置配置
├── tests/                  # 测试目录
│   └── tools/              # 测试工具目录
├── tools/                  # 工具目录
│   ├── config/             # 配置模块
│   ├── logger/             # 日志模块
│   ├── tracer/             # 跟踪模块
│   └── __init__.py         # 工具模块初始化
├── .dockerignore           # Docker 忽略文件
├── .env.local              # 本地环境变量文件
├── .gitignore              # Git 忽略文件
├── .pre-commit-config.yaml # pre-commit 配置文件
├── .python-version         # Python 版本文件
├── Dockerfile              # Dockerfile 文件
├── pyproject.toml          # Python 项目配置文件
├── pyrightconfig.json      # pyright 配置文件
├── pytest.ini              # pytest 配置文件
├── README.md               # 项目说明文件
├── ruff.toml               # Ruff 配置文件
└── uv.lock                 # uv 项目锁文件

2. 项目的启动文件介绍

项目启动主要通过Docker容器来运行。在.devcontainer目录下的Dockerfile定义了构建容器所需的步骤，而devcontainer.json则配置了开发容器所需的环境和设置。

• Dockerfile: 用于定义构建Docker容器镜像的指令，包含了Python环境、依赖库以及其他必要的配置。
• devcontainer.json: 定义了Dev Container的配置，包括哪些扩展将被安装，以及一些VSCode设置。

要启动项目，你需要打开VSCode，使用Dev Container特性来加载配置，并运行Dockerfile构建容器。

3. 项目的配置文件介绍

项目中的配置文件用于定制开发环境的行为和外观。

• .pre-commit-config.yaml: 配置pre-commit钩子，这些钩子在提交代码前自动执行，用于检查代码风格和错误。
• .python-version: 指定了项目所使用的Python版本。
• pyrightconfig.json: 配置pyright，一个用于类型检查的工具。
• pytest.ini: 配置pytest，一个用于单元测试的框架。
• ruff.toml: 配置Ruff，一个快速的Python代码格式化工具和linter。

这些配置文件确保了项目的一致性和代码质量，同时也简化了开发流程。

python-uv This repository contains configurations to set up a Python development environment using VSCode's Dev Container feature. The environment includes uv and Ruff. 项目地址: https://gitcode.com/gh_mirrors/py/python-uv