python安装目录结构_python目录规范和仓库结构

模块

位置：./sample/ 或 ./sample/xx.py

意图：惯用方式

注意： 项目核心文件夹应该放在显眼的地方单项目文件放置于仓库根目录， 文件命名和项目名称最好有关联

LICENCE

位置：./LICENSE

意图：条款和许可证用于授权和法律纠纷

注意： 仓库比较重要的部分，涉及项目的许可和申明信息，版权信息应该写在这个文件里面

如果不知道你的项目该选哪个可以参看网站： choosealicense

Setup.py

位置：./setup.py

意图：打包和项目分布式管理

注意： 如果使用打包管理，应该把setup.py文件放置在根目录

Requirements.txt

位置：./requirements.txt

意图：项目依赖文件和包列表，使用 pip安装

注意：如果你的项目需要额外安装其他python依赖包，则需要用此文件列出安装包的名称和版本号

方便使用 pip install -r requirements.txt进行依赖安装

文档和说明

位置：./docs/

意图：项目相关的说明文档

测试套件

位置：./test_sample.py 或 ./tests

意图：项目集成测试和单元测试相关的套件

Makefile

位置：./test_sample.py 或 ./tests

意图：通用任务管理

注意： 用于任务的通用管理