我参考了一些流行的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配置
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。