搭建Python项目:第六部分

Python项目:第六部分

掌握Python项目设置的艺术:逐步指南

Photo by Amira El Fohail on Unsplash

无论您是经验丰富的开发人员还是刚刚开始学习🐍Python,了解如何构建强大且易于维护的项目都非常重要。本教程将指导您使用行业中最受欢迎且效果最好的工具来设置Python项目的过程。您将学习如何使用GitHub和GitHub Actions进行版本控制和持续集成,以及其他用于测试、文档编写、打包和分发的工具。本教程受到资源(如《Hypermodern Python》和《新Python项目的最佳实践》)的启发。然而,这并不是唯一的方法,您可能有不同的偏好和观点。本教程旨在适合初学者,但也涵盖了一些高级主题。在每个部分中,您将自动化一些任务并向项目添加徽章,以展示您的进展和成就。

本系列教程的存储库可以在github.com/johschmidt42/python-project-johannes找到

要求

  • 操作系统:Linux、Unix、macOS、Windows(使用例如Ubuntu 20.04 LTS的WSL2)
  • 工具:python3.10、bash、git、tree
  • 版本控制系统(VCS)主机:GitHub
  • 持续集成(CI)工具:GitHub Actions

预计您熟悉版本控制系统(VCS)git。如果不熟悉,这里有一个关于Git的简介供您参考:介绍Git

提交将基于git提交和常规提交的最佳实践。PyCharm有常规提交插件,或者您可以使用VSCode扩展来以此格式编写提交。

概述

  • 第一部分(GitHub、IDE)
  • 第二部分(格式化、Linting、CI)
  • 第三部分(测试、CI)
  • 第四部分(文档编写、CI/CD)
  • 第五部分(版本控制和发布、CI/CD)
  • 第六部分(容器化、Docker、CI/CD)

结构

  • 容器化
  • Docker
  • Dockerfile