Python 分发工具初探之 setuptools

这篇文章主要介绍了一下 setuptools 是什么,以及它的功能和特点,并且介绍了如何使用它来创建和安装使用自己的包,这篇文章仅仅讲了最基本的功能和用法,一些对于进阶的用法会在下篇文章中进行介绍。

0x00 setuptools 是什么

setuptools 与 disutils

我们通常所知道的 Python 分发工具是 Python distutils, setuptools 可以说是它的增强版,它能帮助我们更好的创建和分发 Python 的包,尤其是具有复杂依赖关系的包。对于开发者来说,能够更好的组织自己项目的分发和发布;对于用户来说,不需要安装 setuptools 也可以使用由它创建的包,只需要一个启动模块即可。

实现这样的的包管理机制主要由两部分构成:

  • 一个存储在 Python 官方网站的集中式仓库,名叫 Python Package Index(PyPI)
  • 另外就是基于 distutils 开发的 setuptools 包管理系统

它提供的内容包括:

  • 用来提供标准元数据字段:诸如作者名、版权类型等信息的骨架
  • 一组用来将包中的代码来构建软件安装包的辅助工具

distutils 仅仅适用于包,它无法定义包之间的依赖关系。但是 setuptools 通过添加一个基本的依赖系统以及许多相关功能,弥补了该缺陷。他还提供了自动包查询程序,用来自动获取包之间的依赖关系,并完成这些包的安装,大大降低了安装各种包的难度,使之更加方便。

相关功能

  • 利用 EasyInstall 自动查找、下载、安装升级依赖包
  • 能够创建 Python Eggs、
  • 包含目录中的数据文件和包,不需要在 setup() 函数中一一列举出来
  • 自动包含包内和发布有关的所有相关文件,而不用创建一个 MANIFEST.in文件
  • 自动生成经过包装的脚本
  • 支持Pyrex,即在可以 setup.py 中列出 .pyx 文件,而最终用户无须安装Pyrex
  • 支持上传到 PyPI
  • 可以部署开发模式,使项目在sys.path中
  • 用新命令或 setup() 参数扩展distutils,为多个项目发布/重用扩展
  • 在项目的 setup()中简单声明 entry points,创建可以自动发现扩展的应用和框架

0x01 安装 setuptools

Ubuntu:

Mac:

安装 wget:

安装 setuputils:

0x02 创建一个简单的包

创建一个空的包

新建一个 demo 目录

在目录下新建 setup.py 文件

将该项目打包

这时我们查看该项目目录:

我们看到在 dist 目录中的就是生成的 egg 包,将其解压:

以上的程序是最简单的一个 setup.py 程序,如果想要发布到 PyPI 就需要参考官方给出的示例

给包中添加内容

我们上边生成的 egg 是一个空的,没有实际的内容,现在我们来添加一些内容:

在项目目录新建一个目录:

新建 __init__.py,加入如下代码:

再次生成 egg 包:

查看 egg 包内容:

我们看到其中已经多了 test 目录和 __init__.py,然后我们就可以尝试安装一下我们自己的包:

然后该包就会安装到 Python 的 site-packages 目录下,在我的电脑上为 /Library/Python/2.7/site-packages/demo1-0.1-py2.7.egg

这时我们可以在 Python 终端测试我们的包:

我们看到我们编写的包已经成功运行!

0x02 总结

这篇文章主要介绍了一下 setuptools 是什么,以及它的功能和特点,并且介绍了如何使用它来创建和安装使用自己的包,这篇文章仅仅讲了最基本的功能和用法,一些对于进阶的用法会在下篇文章中进行介绍。

 

1 收藏 1 评论

相关文章

可能感兴趣的话题



直接登录
最新评论
跳到底部
返回顶部