Python 开源项目结构总结

[prasanta]

我参考了一些流行的 python 开源项目，总结一下 python 开源项目结构。

基本结构

结构说明

• docs: 项目文档
• tests: 测试代码
• project: 项目内容
• .gitignore: git 忽略文件
• .travis.yml: 配置 travis ci
• AUTHROS.md: 作者及贡献者列表
• HISTORY.md:版本更新历史说明（也可以用 CHANGELOG.md ）
• LISENCE: 开源协议
• README.md: 项目说明
• Makefile: 编译配置（很多时候用不上）
• requirements.txt(运行依赖)
• requirements.dev.txt(开发依赖)
• requirements.test.txt(测试依赖)
• setup.py: 安装配置，多用于发布到 pypi
• tox.ini: 自动化测试工具 tox 配置

模板地址

https://github.com/gaojiuli/project

[zsj950618]

官方指导 https://github.com/pypa/sampleproject

[billlee]

python 应该是用 README.rst

[prasanta]

@billlee rst 我没找到支持 checkbox 的语法

[prasanta]

@zsj950618 还是有点区别的

[xiongbiao]

感觉改动好像叫 changelog 的多一点

[prasanta]

@xiongbiao 我是看 kennethreits 的项目喜欢用 HISTORY, 而且这样感觉要舒服也一些．你觉得呢

[fate0]

可以看看这个模版 https://github.com/audreyr/cookiecutter-pypackage

[prasanta]

@fate0 这个也不错，在我参考的项目里面

[glasslion]

参照下面两个模板就够了:
https://github.com/pypa/sampleproject
https://github.com/audreyr/cookiecutter-pypackage

README.rst 的好处是能显示在 pypi.org 里， 当然项目里用 .md, 打包时转成 .rst 的也不少, 但至少最终的包里应该是 .rst