原标题:亲自动手写一个python库(二)
引言
经过上一节中所述,我们搭建好了一个Python环境用于库开发,我们在这一节真正开始搭建一个库,并将其发布。
项目文档结构
首先我们先构建出自己项目的文档结构,首先是LICENSE和README.md,这两个文件并不是必要的,但是最好将其加上,方便别人了解你的项目。README.md是关于本项目的介绍,LICENSE是表示该项目所遵循的开源协议,一般MIT用的比较多,其他协议你可以百度谷歌了解一下。
接下来是打包库需要的一些文件,主要有MANIFEST.in和setup.py两个文件。MANIFEST.in表示打包时不会被自动包含进去的附加文件清单。setup.py是打包程序配置文件,需要设置一些选项。此外,setup.cfg是包含setup.py额外配置信息的文件,我没有用到这其中的设置,所以本项目中其是空的。
caafinder文件夹就是我们要写的Python程序,我们要注意这个文件夹里必须有__init__.py这个文件。
下面是一下setup.py的一些简单配置选项,详细请参考官方文档。
可以参考一下:
PyPA sample project这是一个官方示例库结构。
Python Packaging User Guide这是Python打包的官方英文文档。
关于模块
模块也就是库,我们自己写程序时,通常通过import XX来导入一个需要的模块,在