Python项目的文件系统结构

Do:

• 以你的项目命名文件夹。如果你的项目叫做"Twisted"， 将顶级目录命名为"Twisted"。 当你发布程序的时候， 你应该包含一个版本号作为后缀：Twisted-2.5。
• 创建一个目录Twisted/bin来安置你所有的可执行文件。不要给它们一个.py后缀，即使它们是Python源代码；不要把任何源码放在这些文件里面，除非这些源码仅仅是引入一些包并调用入口函数；
• 如果你的项目只需要一个源码文件，那么直接将它放在文件夹中，并且将其命名为合适的名字，如Twisted/twisted.py；如果你有大量的源码文件，那么创建一个包，如Twisted/twisted，并在该文件夹下面放置一个空的__init__.py，然后将所有的源码文件放到该包中，如Twisted/twisted/internet.py；
• 将你的单元测试作为源码包的子包放在源码包下(当源码只有一个文件时，单元测试包在顶级目录下)。如Twisted/twisted/test。
• 在顶级目录下编写README和setup.py用于解释，安装你的软件。
  

Don't:

• 不要把源码放在目录，如src或者lib下面。这使得你的软件不经过安装难以运行；
• 不要把测试包放在源码包外。这使得安装后的程序难以测试；
  

原文地址： http://as.ynchrono.us/2007/12/filesystem-structure-of-python-project_21.html