软件目录开发规范

假设程序叫hinimix
hinimix
        bin                 # 存放可执行文件
            hinimix
        hinimix             # 存放所有源码
            tests/              # 单元测试
            main.py             # 程序入口
        docs                # 存放文档
        setup.py            # 安装、部署、打包的脚本
        requizements.txt    # 外部依赖包,使用时候可以用 pip install -r requrements.txt来把依赖包装好
        conf                # 依赖配置目录
        README              # 下面有readme写作规范
        LICENSE             # 授权许可
        CHANGELOG           # 更新日志

README
需要说明一下几个事项:
1、软件定为,软件的基本功能
2、运行的方法:安装环境,启动命令等等
3、简要的使用说明
4、代码目录结构说明,详细点可以说明软件的基本原理
5、常见问题说明

调用其他目录的文件
workpath = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
  sys.path.append(workpath)
# __file__打印当前相对路径
# os.path.abspth()获取参数的相对路径的绝对路径
# os.path.dirname()获取参数的路径名
sys.path.append(workpath)

from conf import settings
from core import main
原文地址:https://www.cnblogs.com/hinimix/p/8193022.html