正确地组织python项目的结构（python 项目结构）

正确地组织python项目的结构（python 项目结构）

统一的项目结构

写了不少python项目后, 越来越认识到python项目结构重要性. 不管项目是否要开源, 是否要提交pypi, 项目结构的一致性带来的好处还有很多: 多人合作开发大家都有个基本的guideline, 别人日后维护也方便, 也容易形成项目开发的best practice.

所以花了写时间, 仔细研究了github上python的 top 10 项目的结构, 项目结构还真不太一样. 比较合我口味的是sandman这个项目. 我做了少许的修改, 主要是将tests package从sandman package下移到顶层目录.

|- LICENSE |- README.md |- TODO.md |- docs | |-- index.md | |-- installation.md | |-- quickstart.md |- sandman | |-- __init__.py | |-- exception.py | |-- model.py | |-- sandman.py |- tests | |-- __init__.py | |-- test_sandman.py |- setup.py |- tox.ini |- .gitignore |- requirements.txt |- requirements_dev.txt ,比requirements.txt多的是单元测试库

Top 10项目的研究发现:

readme.md和setup.py和requirements.txt放在根目录下一个项目至少有3个子目录, docs目录, root package 和tests package的python代码要放在一个package中, 而不是一般的src目录中.tox 测试工具大家都在用.用pytest和nose单元测试工具比较多, 尤其是pytest

脚手架工具:

下载并安装cookiecutter命令行工具,

网站: ​​下载​​

pip install cookiecutter

​​cookiecutter更详细的教材​​

参考:

​​jeffknupp的雄文​​

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。