懂AI
pythonic-project-guidelines

pythonic-project-guidelines

Python工程化开发实践指南 从入门到进阶

该项目为Python开发者提供全面的工程化指南，涵盖环境搭建、编码规范和高级开发实践。内容包括项目初始化、功能开发、测试和打包发布的完整流程，以及类型标注、配置管理和日志使用等进阶主题。同时还涉及Web开发和数据处理等实用领域，适合不同水平的开发者学习和参考。

Python工程化开发项目管理开发实践数据开发Github开源项目
访问官网GitHub

Python 项目工程化开发指南

GitHub Workflow Status (with branch)

文档目标：

以通俗易懂、结构清晰的文档向读者展示如何进行 Python 工程化开发

目标受众：

  • Python 初学者
  • Python 初级开发人员
  • Python 中级开发人员

指南主要包含以下主题：

  • 快速上手（一个最通用、最基础的示例项目）
  • 开发前准备
    • Python 环境的安装
    • 虚拟环境管理
    • IDE 的选择
  • Python 规范
    • 风格规范
    • 语言规范
  • 应用开发实践
    • 初级教程（一个包含完整开发流程的示例项目）
      • 初始化项目
      • 功能开发
      • 测试
      • 打包发布
    • 进阶教程
      • 类型标注
      • 使用配置系统
      • 如何正确使用日志
      • 异常管理
      • 如何更好地进行测试
      • 使用信号解耦逻辑
      • 支持插件化
    • 项目管理
      • 代码检测
      • 项目结构
      • 文档管理
      • 打包发布
    • 开发实践
      • Web
        • Fastapi
        • Django
        • Flask
      • 爬虫
        • Scrapy
        • aiohttp
      • 数据库
        • SQLALchemy
  • 数据开发实践
    • 初级教程

如果您对文档有任何建议或意见，欢迎提交 issues 进行讨论。当然，我们更期待与您共同协作开发，让文档变得更加完善。

使用方式

1. 克隆项目

git clone https://github.com/pyloong/pythonic-project-guidelines

2. 初始化环境

项目预览需要安装 Python 环境来启动服务器，强烈建议使用 Python 3.9+ 的版本。如果本地没有 Python 环境，也可以使用 Docker预览服务器 来启动。

2.1 本地初始化

创建虚拟环境：

python3 -m venv .venv
source .venv/bin/activate

安装依赖：

pip install -r requirements.txt

2.2 使用 Docker 初始化

docker pull squidfunk/mkdocs-material:9.1.11

3. 预览

3.1 本地预览

mkdocs serve

3.2 使用 Docker 预览

unix:

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material:9.1.11

Windows:

docker run --rm -it -p 8000:8000 -v "%cd%":/docs squidfunk/mkdocs-material:9.1.11

协作规范

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

  • fork
  • code
  • pr

编辑推荐精选

讯飞智文

讯飞智文

一键生成PPT和Word，让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目，能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定，还是学生群体的职业生涯规划、实习避坑指南，亦或是活动策划、旅游攻略等内容，它都能提供支持，帮助用户精准表达，轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级，全面对标OpenAI o1

科大讯飞的星火大模型，支持语言理解、知识问答和文本创作等多功能，适用于多种文件和业务场景，提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台，涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能，能为不同需求的用户提供便捷高效的帮助，助力用户轻松获取信息、解决问题，满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目，由多个知名机构联合参与。该项目提供了高效的 LLM（大语言模型）驱动的语音合成方案，支持语音克隆和语音创建功能，可通过命令行界面（CLI）和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数，生成高质量的语音。该项目适用于多种场景，如有声读物制作、智能语音助手开发等。

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境（IDE），通过自动化和多元协作改变开发流程。利用Trae，团队能够更快速、精确地编写和部署代码，从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能，是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
咔片PPT

咔片PPT

AI助力，做PPT更简单！

咔片是一款轻量化在线演示设计工具，借助 AI 技术，实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT，提供海量模板、智能美化、素材替换等功能，适用于销售、教师、学生等各类人群，能高效制作出高品质 PPT，满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文，一站式创作，让内容运营更高效

讯飞绘文，一个AI集成平台，支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容，加速品牌传播，提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台，公文写作神器

AI 材料星，专业的 AI 公文写作辅助平台，为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能，支持 30 + 文稿类型生成，助力快速完成领导讲话、工作总结、述职报告等材料，提升办公效率，是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK，助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK，它为开发者提供了与 OpenAI 模型交互的高效工具，支持工具调用、结果处理、追踪等功能，涵盖多种应用场景，如研究助手、财务研究等，能显著提升开发效率，让开发者更轻松地利用 OpenAI 的技术优势。

Hunyuan3D-2

Hunyuan3D-2

高分辨率纹理 3D 资产生成

Hunyuan3D-2 是腾讯开发的用于 3D 资产生成的强大工具，支持从文本描述、单张图片或多视角图片生成 3D 模型，具备快速形状生成能力，可生成带纹理的高质量 3D 模型，适用于多个领域，为 3D 创作提供了高效解决方案。

3FS

3FS

一个具备存储、管理和客户端操作等多种功能的分布式文件系统相关项目。

3FS 是一个功能强大的分布式文件系统项目，涵盖了存储引擎、元数据管理、客户端工具等多个模块。它支持多种文件操作，如创建文件和目录、设置布局等，同时具备高效的事件循环、节点选择和协程池管理等特性。适用于需要大规模数据存储和管理的场景，能够提高系统的性能和可靠性，是分布式存储领域的优质解决方案。

下拉加载更多