构建Python开源包
项目创建
按照需求,一般需要创建如下目录及文件:
1 | $ tree . |
搭建虚拟运行环境
在搭建自己的库的时候,如果希望有一个干净的项目环境的,可以使用virtualenv。
方便为后面生成私有项目的 requirement.txt
依赖包文件。
可以使用source ~/virtual/bin/activate
进入环境,使用pip freeze > requirement.txt
来生成依赖包文件。
编写项目代码
这一步主要为构建代码的原型架构以及代码,每个包都需要包含一个’init.py’文件。
编写安装脚本
在包的根目录创建文件setup.py,内容一般如下所示:
.. literalinclude:: ../../src/python-package-demo/setup.py
编写文档
进入docs文件夹,运行sphinx-quickstart
,然后编写相应的rst文件即可。
默认的index.rst的内容如下:
.. literalinclude:: ../../../src/python-package-demo/docs/index.rst