Python 项目的结构化

在一个项目的开发周期内, 如何优雅的编写代码至关重要, 但是一个良好的代码仓库也是必不可少的。
你需要合理的安排你的文件,你的目录,可以非常清楚的让别人知道你的项目的名称,作用以及结构。

仓库样例

Kenneth Reitz 推荐的仓库样例 samplemod

samplemod
1. readme

对项目的整体介绍,同时也是一份使用手册,需要时常维护更新。
通常为README.rst/README.md

2. sample

这个是核心代码的存放区, 取一个简单易懂的名字。

3. setup.py

通过setup把核心代码打包发布

4. requirements.txt

存放该项目所有依赖的第三方库, 可以让其他developer可以通过pip快速安装所需开发环境

5. license

阐述该项目的许可说明和授权, 详见choosealicense.com

6. makefile

用于项目的命令管理, 例如 make test/ make dep, 开源项目广泛使用。

7. tests

所有的代码测试都归拢于该目录

8. docs

存放一些文件及其他数据

9. 其他

根据项目的需求增加其他的文件或目录

参考

结构化您的工程

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 前言 Git使用教程 Git是什么 Git是一个开源的分布式版本控制系统,用于敏捷高效地处理任何或小或大的项目。 ...
    90后的思维阅读 4,468评论 0 0
  • 软件目录结构规范 为什么要设计好目录结构? "设计项目目录结构",就和"代码编码风格"一样,属于个人风格问题。对于...
    独行侠_ef93阅读 4,750评论 0 0
  • Git使用教程:https://blog.csdn.net/tgbus18990140382/article/de...
    SkTj阅读 7,779评论 1 11
  • 2018.4.28星期五晴亲子日记(20) 今天五一小长假放假,昊早早就放学了。 清明节时本来约定好了出去旅游,但...
    昊霖妈妈阅读 1,105评论 0 3
  • 时间列车带着我们加速前进,窗外的美景稍纵即逝,可我们却不曾欣赏。 我们的脸上总是带着坐车的疲惫和辛酸,因为我们大部...
    阳木易春阅读 3,947评论 0 0