Python项目模板

本项目遵循PEP 621中声明的Python标准。本项目使用pyproject.yaml来配置项目。在这个例子中，使用flit简化构建过程，并发布到pypi。

项目组织

• .devcontainer - 此目录包含创建Codespace所需的文件。
• .github
  • workflows - 包含用于构建、测试和发布的GitHub Actions。
    • publish-test.yml - 将轮子发布到https://test.pypi.org/
    • publish.yml - 将轮子发布到https://pypi.ac.cn/
    • pull-request.yml - 在提交到主分支之前构建和测试pull请求。
    • template-sync.yml - 更新GitHub仓库，以包含对基本模板的增强。
• docs - 收集文档（默认格式.md）
• src - 将新源代码放置在此处
  • python_package - 示例包（创建新仓库时可以删除）
• tests - 包含用于验证src代码的基于Python的测试用例
• .pre-commit-config.yaml - 包含各种Python的预检查修复
• .templateversionrc - 用于跟踪模板版本的使用。
• MANIFEST.in - 声明要包含在Python whl中的附加文件
• pyproject.toml - Python项目声明
• ws.code-workspace - 推荐的Visual Studio Code配置

pyproject.toml

以下部分在配置toml中定义。

• build-system
• project
  • optional-dependencies
  • urls
• tool
  • bandit
  • 覆盖率
    • 运行
    • 报告
  • pyright
  • pytest
  • tox
  • pylint
    • 消息控制
    • 报告
    • 重构
    • 基本
    • 格式
    • 日志
    • 杂项
    • 相似性
    • 拼写
    • 字符串
    • 类型检查
    • 变量
    • 类
    • 设计
    • 导入
    • 异常

build-system

TODO：添加有关flit配置的信息

project

本节定义了项目元数据，这些元数据可能以前包含在setup.py文件中。

optional-dependencies

这是可以通过'pip install .[tests]'安装的优化依赖关系组。一个组包括测试所需的依赖关系。另一个组包括基于PySpark的依赖关系。

tool

本节定义了用于格式化、lint、类型检查和分析Python代码的额外工具的配置。

bandit

对代码库执行安全静态分析检查。

black

自动格式化代码

覆盖率

配置测试期间生成的代码覆盖率报告。

pyright

对Python执行静态类型检查。

pytest

配置测试期间使用的各种测试标记。

pylint

执行linting和静态分析。自动格式化器（black）所做的任何修改都始终被视为正确。

从GitHub发布到PyPi

为了发布到PyPi，必须创建一个仓库密钥，"PYPI_PASSWORD"。为了发布到测试PyPi，必须添加第二个密钥，"TEST_PYPI_PASSWORD"。

贡献

本项目欢迎贡献和建议。大多数贡献都需要您同意贡献者许可协议（CLA），声明您有权并且确实授予我们使用您贡献的权利。有关详细信息，请访问https://cla.opensource.microsoft.com。

当您提交拉取请求时，CLA机器人会自动确定您是否需要提供CLA，并适当地装饰PR（例如，状态检查，评论）。只需遵循机器人提供的说明即可。您只需在所有使用我们CLA的存储库中这样做一次。

本项目采用了Microsoft开源行为准则。有关更多信息，请参阅行为准则FAQ或通过opencode@microsoft.com联系以获取任何额外的问题或评论。

商标

本项目可能包含项目、产品或服务的商标或徽标。Microsoft商标或徽标的授权使用受Microsoft商标和品牌指南约束，必须遵守。在修改后的本项目版本中使用Microsoft商标或徽标不得引起混淆或暗示Microsoft的赞助。任何使用第三方商标或徽标的行为均受那些第三方政策的约束。