Python项目通用的目录结构总结

发布时间:2019-07-22 17:03:47编辑:auto阅读(1595)

    这里写图片描述

    一个好的项目结构会让我们在开发中更加得心应手。

    • 对于Web项目,我们通常采用Flask或Django等框架,会有一套适合这种项目的工程目录。
    • 对于爬虫项目,通常有Scrapy等开源框架,也会提供一套适合这种项目的工程目录。
    • 对于通用的一些Python项目,如何组织一个简单好用的结构,在网上看了一圈,我整理出一个目录结构,供大家参考。

    Python通用目录结构

    ProjectName
    │ readme 项目说明文档
    │ requirements.txt 存放依赖的外部Python包列表
    │ setup.py 安装、部署、打包的脚本
    ├─ bin 存放脚本,执行文件等
    │ └─ projectname
    ├─ docs 文档和配置
    │ └─ abc.rst
    │ └─ conf.py 配置文件
    └─ projectname 工程源码(包括源码、测试代码等)
    │ main.py 程序入口
    init.py
    └─ tests 测试代码
    └─ test_main.py
    └─ init.py

    对于开源的Python项目,一般还会涉及版权方面的信息,可以参考一下文章:
    https://www.cnblogs.com/holbrook/archive/2012/02/24/2366386.html

关键字