omotcha / PythonGuide

A chinese guide for python

Python项目开发指南

文档目标

以通俗易懂结构清晰的文档向读者展示如何做 Python 工程化，以及其他相关**（如Python设计模式，代码重构等）和技术（如Git版本控制等）。

受众目标：

• Python 初级开发
• Python 中级开发

指南主要包含以下主题：

• 项目开发

  • 基础教程
    • 项目结构
    • 日志
    • 配置文件
    • 文档教程
  • 进阶教程
    • 代码检测
    • 设计模式
    • 代码重构

• Python 规范

  • 风格规范
  • 语言规范

• Git版本控制

• 参考目录

参考

1. Google Python风格指南中文版
2. Python最佳实践指南
3. Python项目工程化开发指南
4. Python CookBook
5. Python Design Patterns
6. Git大全
7. 深入浅出Git教程

写作

文档使用 Markdown 编写，使用 mkdocs 配合 mkdocs-material 主题构建。

• MkDocs官方中文文档
• Mkdocs 配置和使用 -知乎