$ python setup.py install
点击上方“编程派”,选择设为“设为星标” 优质文章,第一时间送达!
- 为什么需要对项目分发打包?
在平常,我们通常使用pip来安装第三方模块。这个安装过程之所以简单,是因为模块开发者为我们默默地完成了所有繁杂的工作,这个过程就是打包。
打包是将源代码进一步封装,并将所有项目部署工作事先安排好的过程。这样,使用者拿到后即可安装和使用,无需再操心如何部署的问题(如果你不想对照着一堆部署文档手工操作的话)。
无论是在工作中还是业余时间准备自己写一个可以上传到PyPI的项目,你都需要学会如何打包你的项目。
Python发展了这么多年,项目打包工具也已经很成熟了。你可能听说过disutils、distutils、distutils2、setuptools等等,它们似乎很熟悉,但又很陌生。那么它们之间到底有什么关系呢?
- 包分发的始祖:distutils
distutils是Python的一个标准库,从命名上很容易看出它是一个分发(distribute)工具(utils)。它是Python官方开发的一个分发打包工具,所有后续的打包工具都是基于它进行开发的。
distutils的精髓在于编写setup.py,它是模块分发与安装的指导文件。那么如何编写setup.py呢?这里面的内容非常多,我会在后面进行详细的解析,请你耐心往下看。
你可能没有写过setup.py,但你绝对使用过setup.py来做一些事情,比如下面这条命令,我们经常用它来进行模块的安装。
$ wget http://peak.telecommunity.com/dist/ez_setup.py# 安装$ python ez_setup.py# 更新,以下两种任选$ python ez_setup.py –U setuptools$ pip install -U setuptools
这样的安装方法是通过源码安装,与之对应的是通过二进制软件包的安装,同样我也会在后面进行介绍。
- 分发工具升级:setuptools
setuptools是distutils的增强版,不包括在标准库中。它扩展了很多功能,能够帮助开发者更好地创建和分发Python包。大部分Python用户都会使用更先进的setuptools模块。
你可能在其他地方也见过distribute,这里也提一下。distribute是setuptools的一个分支版本,分支的原因可能是有一部分开发者认为setuptools开发太慢了。但现在,distribute又合并回了setuptools中。因此,我们可以认为它们是同一个东西。
还有一个大包分发工具是distutils2,它试图充分利用distutils、setuptools和distribute,并成为Python标准库中的标准工具。但该计划并没有达到预期的目的,且已经是一个废弃的项目。
因此,setuptools是一个优秀的、可靠的Python包安装与分发工具。
那么如何在一个干净的环境中安装setuptools呢?
主要有两种方法:
• 源码安装:在#files中下载zip包,解压后执行python setup.py install进行安装
• 通过引导程序安装:下载引导程序,它可以用来下载或者更新最新版本的setuptools
# 通过包名,从PyPI寻找最新版本,自动下载、编译、安装$ easy_install pkg_name# 通过包名从指定下载页寻找链接来安装或升级包$ easy_install -f http://pythonpaste.org/package_index.html # 指定线上的包地址安装$ easy_install http://example.com/path/to/MyPackage-1.2.3.tgz# 从本地的 .egg 文件安装$ easy_install xxx.egg# 在安装时你可以添加额外的参数指定安装目录:--install-dir=DIR, -d DIR指定用户安装:--user
- easy_install使用指南
当你安装完setuptools后,就拥有了一个叫做easy_install的第三方管理工具,这也是它与distutils的一大改进之处。
这里简单介绍一下它的用法,虽然它已经用得非常少了。
首先是包的安装。
# 从 pypi 中搜索并升级包$ easy_install --upgrade pkg_name# 指定版本进行升级$ easy_install "SomePackage==2.0"
然后是包的升级。
最后是包的删除。
需要注意的是,这样的删除仅在easy-install.pth文件中删除,使其不能在Python中使用这个模块,但实际的包还在你的电脑中。若要彻底删除,需要你手动删除相关的.egg及其他文件。
默认情况下,easyinstall只会从PyPI上下载相关软件包。由于这个源在国外,下载包的速度并不理想。使用过pip的朋友自然会想,easyinstall是否能指定源进行安装呢?
答案是可以的。
编辑配置文件/root/.pydistutils.cfg
以上仅介绍了easy_install的一些常用方法。想要了解更多,你可以点击官方文档:
总结一句:setuptools是官方提供的一个专业用于包分发的工具,若只从安装的角度来看,它的功能确实简单。它更大的意义是对包的分发很有用,定制化程度非常高。我们现在也还在使用它进行版本包的发布。
- 源码包与二进制包的区别?