项目目录内容,项目文件目录

　　为了提高程序的可读性和可维护性，我们应该为软件设计一个好的目录结构，这和标准的编码风格一样重要。软件目录规范中并没有硬性的标准，只要清晰易读即可。假设您的软件名为XXX，我推荐目录结构如下

　　XXX/

　　 -核心/

　　 - core.py

　　 - api/

　　 - api.py

　　 - db/

　　 -数据库句柄. py

　　 - lib/

　　 - common.py

　　 - conf/

　　 - settings.py

　　 - run.py

　　 - setup.py

　　 - requirements.txt

　　 -自述简要说明：

　　Core/:存储业务逻辑相关代码。

　　API/:存储接口文件，主要用于为业务逻辑提供数据操作。

　　DB/:存储与操作数据库相关的文件，主要用于与数据库进行交互。

　　Lib/:存储程序中常用的自定义模块。

　　Conf/:存储配置文件

　　Run.py:程序的启动文件通常放在项目的根目录下，因为运行文件所在的文件夹在运行时默认会是sys.path的第一个路径，这样就省去了处理环境变量的步骤。

　　Setup.py:用于安装、部署和打包的脚本。

　　Requirements.txt:软件所依赖的外部Python包的列表。

　　自述文件：项目描述文件。

　　除此之外，还有一些方案给出的内容比较多，比如LICENSE.txt，ChangeLog.txt文件，主要用在项目需要开源的时候。请自行咨询他们。

　　关于README的内容，这应该是每个项目都应该有的文件。目的是简要描述项目的信息，让读者快速了解。一般管理检查根本不可读。需要说明以下事项：

　　1、软件定位，软件的基本功能；

　　2.运行代码的方法：安装环境、启动命令等。

　　3.简要的使用说明；

　　4.代码目录结构的描述。更多的细节可以说明软件的基本原理；

　　5.常见问题描述。关于setup.py和requirements.txt:

　　一般来说，setup.py用于管理代码打包、安装和部署的问题。行业标准的编写方式是使用Python流行的打包工具setuptools来管理这些东西，在开源项目中广泛使用。但是，这里的核心思想并不是用标准化的工具来解决这些问题，而是说一个项目必须有一个安装部署工具，能够快速方便地在新机器上安装环境，部署代码，运行程序。

　　requirements.txt文件的存在是为了方便开发者维护软件的依赖库。我们需要在这个文件中加入开发过程中依赖库的信息，避免在setup.py中安装依赖时遗漏软件包，同时也方便用户了解项目引用了哪些Python包。

　　这个文件的格式是每行包含一个包依赖关系的描述，通常是flask=0.10的格式。要求这种格式可以被pip识别，这样所有的Python依赖库都可以简单的通过PIPIPInstall-rRequirements.txt安装。

　　转载请联系作者获得授权，否则将追究法律责任。

郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。