Python打包分发工具setuptools

作为Python标准的打包及分发工具,setuptools可以说相当地简单易用。它会随着Python一起安装在你的机器上。你只需写一个简短的setup.py安装文件,就可以将你的Python应用打包

首先,如果你需要另外安装setuptools,你可以使用下面的命令:

wget http://peak.telecommunity.com/dist/ez_setup.py

sudo python ez_setup.py

第一个安装文件

接下来让我们编写安装文件,假设我们的项目名为setup-demo,包名为myapp,目录结构如下:

setup-demo/
  ├ setup.py         # 安装文件
  └ myapp/           # 源代码
      ├ __init__.py
      ...

一个最基本的setup.py文件如下:

#coding:utf8
from setuptools import setup

setup(
    name=‘MyApp‘,         # 应用名
    version=‘1.0‘,        # 版本号
    packages=[‘myapp‘]    # 包括在安装包内的Python包
)

执行安装文件

有了上面的setup.py文件,我们就可以打各种包,也可以将应用安装在本地Python环境中。

创建egg包

python setup.py bdist_egg

该命令会在当前目录下的”dist”目录内创建一个egg文件,名为”MyApp-1.0-py2.7.egg”。文件名格式就是”应用名-版本号-Python版本.egg”,我本地Python版本是2.7。同时你会注意到,当前目录多了”build”和”MyApp.egg-info”子目

同上例类似,只不过创建的文件类型是tar.gz,文件名为”MyApp-1.0.tar.gz”。

安装应用

python setup.py install

该命令会将当前的Python应用安装到当前Python环境的”site-packages”目录下,这样其他程序就可以像导入标准库一样导入该应用的代码了

开发方式安装

python setup.py develop

如果应用在开发过程中会频繁变更,每次安装还需要先将原来的版本卸掉,很麻烦。使用”develop”开发方式安装的话,应用代码不会真的被拷贝到本地Python环境的”site-packages”目录下,而是在”site-packages”目录里创建一个指向当前应用位置的链接。这样如果当前位置的源码被改动,就会马上反映到”site-packages”里。

引入非Python文件

上例中,我们只会将”myapp”包下的源码打包,如果我们还想将其他非Python文件也打包,比如静态文件(JS,CSS,图片),应该怎么做呢?这时我们要在项目目录下添加一个”MANIFEST.in”文件夹。假设我们把所有静态文件都放在”static”子目录下,现在的项目结构如下:

setup-demo/
  ├ setup.py         # 安装文件
  ├ MANIFEST.in      # 清单文件
  └ myapp/           # 源代码
      ├ static/      # 静态文件目录
      ├ __init__.py
      ...

我们在清单文件”MANIFEST.in”中,列出想要在包内引入的目录路径:

recursive-include myapp/static *
recursive-include myapp/xxx *

“recursive-include”表明包含子目录。还有一件事要做,就是在”setup.py”中将” include_package_data”参数设为True:

#coding:utf8
from setuptools import setup

setup(
    name=‘MyApp‘,         # 应用名
    version=‘1.0‘,        # 版本号
    packages=[‘myapp‘],   # 包括在安装包内的Python包
    include_package_data=True    # 启用清单文件MANIFEST.in
)

之后再次打包或者安装,”myapp/static”目录下的所有文件都会被包含在内。如果你想排除一部分文件,可以在setup.py中使用”exclude_package_date”参数,比如:

setup(
    ...
    include_package_data=True,    # 启用清单文件MANIFEST.in
    exclude_package_date={‘‘:[‘.gitignore‘]}
)

上面的代码会将所有”.gitignore”文件排除在包外。如果上述”exclude_package_date”对象属性不为空,比如”{‘myapp’:[‘.gitignore’]}”,就表明只排除”myapp”包下的所有”.gitignore”文件。

自动安装依赖

我们的应用会依赖于第三方的Python包,虽然可以在说明文件中要求用户提前安装依赖包,但毕竟很麻烦,用户还有可能装错版本。其实我们可以在setup.py文件中指定依赖包,然后在使用setuptools安装应用时,依赖包的相应版本就会被自动安装。让我们来修改上例中的setup.py文件,加入”install_requires”参数:

#coding:utf8
from setuptools import setup

setup(
    name=‘MyApp‘,         # 应用名
    version=‘1.0‘,        # 版本号
    packages=[‘myapp‘],   # 包括在安装包内的Python包
    include_package_data=True,    # 启用清单文件MANIFEST.in
    exclude_package_date={‘‘:[‘.gitignore‘]},
    install_requires=[    # 依赖列表
        ‘Flask>=0.10‘,
        ‘Flask-SQLAlchemy>=1.5,<=2.1‘
    ]
)

上面的代码中,我们声明了应用依赖Flask 0.10及以上版本,和Flask-SQLAlchemy 1.5及以上、2.1及以下版本。setuptools会先检查本地有没有符合要求的依赖包,如果没有的话,就会从PyPI中获得一个符合条件的最新的包安装到本地。

执行下试试,会发现不但Flask 0.10.1(当前最新版本)被自动安装了,连Flask的依赖包Jinja2和Werkzeug也被自动安装了

如果应用依赖的包无法从PyPI中获取怎么办,我们需要指定其下载路径:

setup(
    ...
    install_requires=[    # 依赖列表
        ‘Flask>=0.10‘,
        ‘Flask-SQLAlchemy>=1.5,<=2.1‘
    ],
    dependency_links=[    # 依赖包下载路径
        ‘http://example.com/dependency.tar.gz‘
    ]
)

路径应指向一个egg包或tar.gz包,也可以是个包含下载地址(一个egg包或tar.gz包)的页面。个人建议直接指向文件。

自动搜索Python包

之前我们在setup.py中指定了”packages=[‘myapp’]”,说明将Python包”myapp”下的源码打包。如果我们的应用很大,Python包很多怎么办。大家看到这个参数是一个列表,我们当然可以将所有的源码包都列在里面,但肯定很多人觉得这样做很傻。的确,setuptools提供了”find_packages()”方法来自动搜索可以引入的Python包:

#coding:utf8
from setuptools import setup, find_packages

setup(
    name=‘MyApp‘,               # 应用名
    version=‘1.0‘,              # 版本号
    packages=find_packages(),   # 包括在安装包内的Python包
    include_package_data=True,   # 启用清单文件MANIFEST.in
    exclude_package_date={‘‘:[‘.gitignore‘]},
    install_requires=[          # 依赖列表
        ‘Flask>=0.10‘,
        ‘Flask-SQLAlchemy>=1.5,<=2.1‘
    ]
)

这样当前项目内所有的Python包都会自动被搜索到并引入到打好的包内。”find_packages()”方法可以限定你要搜索的路径,比如使用”find_packages(‘src’)”就表明只在”src”子目录下搜索所有的Python包。

补充

  • zip_safe参数

  决定应用是否作为一个zip压缩后的egg文件安装在当前Python环境中,还是作为一个以.egg结尾的目录安装在当前环境中。因为有些工具不支持zip压缩文件,而且压缩后的包也不方便调试,所以建议将其设为False:”zip_safe=False”。

  • 描述信息

部分参数提供了更多当前应用的细节信息,对打包安装并无任何影响,比如:

setup(
    ...
    author = "Billy He",
    author_email = "[email protected]",
    description = "This is a sample package",
    license = "MIT",
    keywords = "hello world example",
    url = "http://example.com/HelloWorld/",   # 项目主页
    long_description=__doc__,   # 从代码中获取文档注释
)
时间: 2024-10-10 18:38:48

Python打包分发工具setuptools的相关文章

Python 打包中 setpy.py settuptools pbr 的了解

背景 nova服务构建失败,报错: 'tests_require' must be a string or list of strings containing valid project/version requirement specifiers 概述 推荐-Python 包管理工具解惑 openstack/nova setup.py 孔令贤-关于python中的setup.py 簡單的插件框架 - 使用 pkg_resources python setup.py --help-comman

Python打包工具setuptools的使用

将我们写的Python程序发布成包后,可以使其能够安装使用. 在项目上测试的时候,某些情况下,可以将Python打包,然后上传到测试服务器,安装测试. setuptools是常用的打包工具. 一个简单的setup.py文件如下: from setuptools import setup, find_packages setup( name = "my_demo", version = "0.1", packages = find_packages() ) 其中,na

python打包工具distutils、setuptools分析

在上一篇博文中总结了python中导入包,安装包一条完整的线路.其中有一个有意思的知识点,安装包的方式有很多种,模块和包管理中打包,发布,安装也是值得研究的内容. python中安装包的方式有很多种: 源码包:python setup.py install 在线安装:pip install 包名(linux) / easy_install 包名(window) python包在开发中十分常见,一般的使用套路是所有的功能做一个python模块包,打包模块,然后发布,安装使用.打包和安装包就是最常见

Python 库打包分发简易指南

Python 库打包分发(setup.py 编写)简易指南 Python 有非常丰富的第三方库可以使用,很多开发者会向 pypi 上提交自己的 Python 包.要想向 pypi 包仓库提交自己开发的包,首先要将自己的代码打包,才能上传分发. distutils 简介 distutils 是标准库中负责建立 Python 第三方库的安装器,使用它能够进行 Python 模块的安装和发布.distutils 对于简单的分发很有用,但功能缺少.大部分Python用户会使用更先进的setuptools

[转]Python打包工具

作者:Tarek Ziadé,翻译:张吉 原文:http://www.aosabook.org/en/packaging.html 转载地址:http://www.ituring.com.cn/article/19090 14.1 简介 对于如何安装软件,目前有两种思想流派.第一种是说软件应该自给自足,不依赖于其它任何部件,这点在Windows和Mac OS X系统中很流行.这种方式简化了软件的管理:每个软件都有自己独立的“领域”,安装和卸载它们不会对操作系统产生影响.如果软件依赖一项不常见的类

Windows+Linux安装Python工具setuptools

Windows+Linux安装Python工具setuptools setuptools是 Python Enterprise Application Kit(PEAK)的一个副项目,它 是一组Python的 distutilsde工具的增强工具(适用于 Python 2.3.5 以上的版本,64 位平台则适用于 Python 2.4 以上的版本),可以让程序员更方便的创建和发布 Python 包,特别是那些对其它包具有依赖性的状况. 经常接触Python可能会注意到,当需要安装第三方pytho

python打包成.exe工具py2exe0-----No such file or directory错误

转自:http://justcoding.iteye.com/blog/900993 一.简介 py2exe是一个将python脚本转换成windows上的可独立执行的可执行程序(*.exe)的工具,这样,你就可以不用装python而在windows系统上运行这个可执行程序. py2exe已经被用于创建wxPython,Tkinter,Pmw,PyGTK,pygame,win32com client和server,和其它的独立程序.py2exe是发布在开源许可证下的. 二.安装py2exe 从h

最详细的Python打包工具:Pyinstaller实战指南,如丝滑般体验

写了个吊炸天的Python项目,把我和左手相处的时间都赔上了.但出于版权考虑,我不太想让使用方直接用我的代码,毕竟Python代码给出去,就真的收不回来了. 想给客户演示的时候,不想那么墨迹的打开dos cmd 或者 terminal ,然后运行 python app.py 这样的命令行.最好是客户双击,完事儿.就像有人在那自己动一样-- PyInstaller 来了,他就是这么一款帮助我们把整个项目完整打包的工具.目前已经兼容Py3.7,以及 Mac App 和 Windows Exe. 文档

Python包管理工具小结

此文已由作者张耕源授权网易云社区发布. 欢迎访问网易云社区,了解更多网易技术产品运营经验. 作为一名接触Python有一段时间的初学者,越来越体会到Python的方便之处,它使人能更 多的关注业务本身的逻辑,而不用太纠结语言层面的技巧与细节.然而,随着服务的规模 变得越来越大,如何方便快速地制作与发布一个Python软件包则越来越成为一个让人头疼 地问题,特别是像Openstack这种相对复杂.各种依赖也很多的Python项目,到目前也没有 发现特别完美的解决方案.这里将尝试对Python的包管