python项目小谈
项目结构
.
├── docs
│ ├── conf.py
│ ├── index.rst
│ └── quickstart.rst
├── foobar
│ ├── cli.py
│ ├── __init__.py
│ ├── storage.py
│ └── tests
│ ├── __init__.py
│ ├── test_cli.py
│ └── test_storage.py
├── README.rst
├── requirements.txt
├── setup.py
└── test_requirements.txt
另外,那些额外的数据如图片,shell脚本放在任何合适的地方都可以。
还有常见的顶层目录如:
etc用来放配置文件的样例
tools用来放与工具有关的shell脚本
bin用来放将被setup.py安装的二进制脚本
data用来存放其他类型的文件,如媒体文件。
常见版本号
PEP440定义:
N[.N]+[{a|b|c|rc}N][.postN][.devN]
其中
- rc表示候选版本
- .postN表示后续版本,常用来解决细小问题。
- .devN表示开发版本。
可以使用pbr,基于项目的Git版本自动生成版本号。
编码风格
Python的常见编码风格这里不再赘述。可以使用PEP8进行检测。后期可以考虑将其集成到测试中。
可以使用pip install hacking
或pip install flake8
安装测试工具。
@Cheng