Directory_rules

Foo/

|-- bin/

|   |-- foo

|

|-- foo/

|   |-- tests/

|   |   |-- __init__.py

|   |   |-- test_main.py

|   |

|   |-- __init__.py

|   |-- main.py

|

|-- docs/

|   |-- conf.py

|   |-- abc.rst

|

|-- setup.py

|-- requirements.txt

|-- README

 

 

 

    bin/: 存放项目的一些可执行文件，当然你可以起名script/之类的也行。

    foo/: 存放项目的所有源代码。(1) 源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。(2) 其子目录tests/存放单元测试代码； (3) 程序的入口最好命名为main.py。

    docs/: 存放一些文档。

    setup.py: 安装、部署、打包的脚本。

    requirements.txt: 存放软件依赖的外部Python包列表。

    README: 项目说明文件。

 

除此之外，有一些方案给出了更加多的内容。比如LICENSE.txt,ChangeLog.txt文件等，我没有列在这里，因为这些东西主要是项目开源的时候需要用到。如果你想写一个开源软件，目录该如何组织，可以参考这篇文章。

 

下面，再简单讲一下我对这些目录的理解和个人要求吧。

关于README的内容

 

这个我觉得是每个项目都应该有的一个文件，目的是能简要描述该项目的信息，让读者快速了解这个项目。

 

它需要说明以下几个事项:

 

    软件定位，软件的基本功能。

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

    简要的使用说明。

    代码目录结构说明，更详细点可以说明软件的基本原理。

    常见问题说明。

 

我觉得有以上几点是比较好的一个README。在软件开发初期，由于开发过程中以上内容可能不明确或者发生变化，并不是一定要在一开始就将所有信息都补全。但是在项目完结的时候，是需要撰写这样的一个文档的。

 

可以参考Redis源码中Readme的写法，这里面简洁但是清晰的描述了Redis功能和源码结构。

 

From WizNote