Python项目目录结构规范

涉及Python开发的项目，均需依照下列目录结构进行设计与开发：

|—— 1.References				# 参考文献目录
|—— 2.Project						# 项目代码
	|——— conf/						# 项目配置目录，所有的静态参数、文件路径、数据库配置等全部放在该目录下
		|—— settings.py
		|—— ……
	|—— bin/							# 脚本目录，如有需要执行的脚本文件，存放在此处。
		|—— test.sh
		|—— ……
	|—— common/						# 公共文件目录，存放公共组件函数，如：加密、序列化、以及自定义的函数等
		|—— encryption.py
		|—— ……
	|—— ……
	|—— ……
	|—— log/							# 项目日志目录，用于存放各类日志
	|—— main.py						# 项目入口文件 
|—— README.md  					# 项目说明文档
|—— requirements.txt  	# 需要安装的包及版本号
|—— .gitignore					# git版本管理配置文件

特别说明：

1.References： 参考文献目录。如果涉及论文，需要将原论文.pdf版本的文件上传至此。

bin目录： 项目配置文件。所有的静态参数、文件路径、数据库配置等全部放在该目录下。例如：下面是一段读取本地文件的代码（属于静态参数），这部分代码需要在conf目录下创建.py文件进行管理。目录下的py文件可以自定义名称，如settings.py、mysql-settings.py等。

root_path = "/Users/allenpandas/Downloads/PCD-1/"

files = os.listdir(root_path)

bin目录： 脚本目录。项目运行过程中如有需要执行的脚本文件，存放在此处。

common目录： 公共文件目录。用于存放公共组件函数，如：加密、序列化、以及自定义的函数等。

log目录： 日志文件目录。用于存放各类日志文件，项目如有日志输出，必须放在该目录下。

main.py： 项目入口文件。

README.md： 项目说明文档，必须要对项目有详细的说明，包括但不限于项目环境、执行过程、数据流、注意事项等。

requirements.txt： python包及版本号管理文件。需要将项目运行时，依赖的安装包及包的版本号记录在此，方便其他协作人员通过pip install -r requirements.txt文件安装开发环境。

.gitignore： Git版本管理配置文件，项目中无需提交的代码文件、目录、日志文件等均需在此标明。