https://github.com/wangzhe3224/python_project_template

https://github.com/wangzhe3224/python_project_template

Last synced: 11 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/wangzhe3224/python_project_template
• Owner: wangzhe3224
• License: other
• Created: 2021-09-24T21:30:39.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-09-25T09:32:42.000Z (about 4 years ago)
• Last Synced: 2025-01-15T13:28:52.840Z (9 months ago)
• Language: Python
• Size: 5.86 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Python Start Project Template

![Tests](https://github.com/wangzhe3224/python_project_template/actions/workflows/test.yml/badge.svg)

: )

如何配置一个自动测试的Python项目?

前置知识：

- 如何配置虚拟环境

- github的基本使用

1. 项目结构

    1. 分离源代码和测试

    2. 配置项目本地安装

       1. `pyproject.toml`

       2. `setup.py/cfg`

       3. `requirements.txt`

       4. `pip install -e .`

2. 自动测试、类型检查、代码规范检查

   1. pytest/mypy/flake8

   2. `requirements_dev.txt`

   3. 配置`setup.cfg`，增加pytest,mypy,flake的相关配置

   4. 配置`pyproject.toml`，增加pytest，mypy的相关配置

3. 多环境测试

   1. 配置`tox.ini`

2. 自动测试，Github Action

   1. 配置 GH on commit 动作

   2. 增加 readme 的测是·标签