Python的构建工具setup.py

参考原文：https://www.cnblogs.com/maociping/p/6633948.html

 

一、构建工具setup.py的应用场景

在安装python的相关模块和库时，我们一般使用“pip install 模块名”或者“python setup.py install”，前者是在线安装，会安装该包的相关依赖包；后者是下载源码包然后在本地安装，不会安装该包的相关依赖包。所以在安装普通的python包时，利用pip工具相当简单。但是在如下场景下，使用python setup.py install会更适合需求：

假如我在本机开发了个程序，需要用到python的redis、mysql模块以及自己编写的redis_run.py模块。怎么实现在服务器上去发布该系统，如何实现依赖模块和自己编写的模块redis_run.py一起打包，实现一键安装呢？

在这种应用场景下，pip工具似乎派不上了用场，只能使用python的构建工具setup.py了，使用此构建工具可以实现上述应用场景需求，只需在setup.py

 

二、setup.py文件的简单示例

from setuptools import setup, find_packages

setup(
    name="test0122",
    version="1.0.0",

    author="chenxy",
    author_email="chenxy@qq.com",

    #自动寻找带有 __init__.py 的文件夹
    packages=find_packages(exclude=["logs"]),

    description = "test0122",
    scripts=["scripts/test0122.py"],

)

三、setup.py 各参数介绍

--name 包名称 --version (-V) 包版本 --author 程序的作者 --author_email 程序的作者的邮箱地址 --maintainer 维护者 --maintainer_email 维护者的邮箱地址 --url 程序的官网地址 --license 程序的授权信息 --description 程序的简单描述 --long_description 程序的详细描述 --platforms 程序适用的软件平台列表 --classifiers 程序的所属分类列表 --keywords 程序的关键字列表 --packages 需要处理的包目录（包含__init__.py的文件夹）  --py_modules 需要打包的python文件列表 --download_url 程序的下载地址 --cmdclass  --data_files 打包时需要打包的数据文件，如图片，配置文件等 --scripts 安装时需要执行的脚步列表 --package_dir 告诉setuptools哪些目录下的文件被映射到哪个源码包。一个例子：package_dir = {'': 'lib'}，表示“root package”中的模块都在lib 目录中。 --requires 定义依赖哪些模块  --provides定义可以为哪些模块提供依赖  --find_packages() 对于简单工程来说，手动增加packages参数很容易，刚刚我们用到了这个函数，它默认在和setup.py同一目录下搜索各个含有 __init__.py的包。                           其实我们可以将包统一放在一个src目录中，另外，这个包内可能还有aaa.txt文件和data数据文件夹。另外，也可以排除一些特定的包                           find_packages(exclude=["*.tests", "*.tests.*", "tests.*", "tests"]) --install_requires = ["requests"] 需要安装的依赖包 --entry_points 动态发现服务和插件，下面详细讲

setup.py中主要执行一个setup函数，该函数中大部分是描述性东西，最主要的是packages参数，列出所有的package，可以用自带的find_packages来动态获取package。

 

四、setup.py文件的使用

 python setup.py build #编译
 python setup.py install    #安装
 python setup.py sdist     #制作分发包
 python setup.py bdist_wininst  #制作windows下的分发包
 python setup.py bdist_rpm

五、setup.py项目文件示例

1 #!/usr/bin/env python
 2 # coding=utf-8
 3 
 4 from setuptools import setup
 5 
 6 '''
 7 把redis服务打包成C:\Python27\Scripts下的exe文件
 8 '''
 9 
10 setup(
11     name="RedisRun",  #pypi中的名称，pip或者easy_install安装时使用的名称
12     version="1.0",
13     author="Andreas Schroeder",
14     author_email="andreas@drqueue.org",
15     description=("This is a service of redis subscripe"),
16     license="GPLv3",
17     keywords="redis subscripe",
18     url="https://ssl.xxx.org/redmine/projects/RedisRun",
19     packages=['DrQueue'],  # 需要打包的目录列表
20 
21     # 需要安装的依赖
22     install_requires=[
23         'redis>=2.10.5',
24     ],
25 
26     # 添加这个选项，在windows下Python目录的scripts下生成exe文件
27     # 注意：模块与函数之间是冒号:
28     entry_points={'console_scripts': [
29         'redis_run = DrQueue.RedisRun.redis_run:main',
30     ]},
31 
32     # long_description=read('README.md'),
33     classifiers=[  # 程序的所属分类列表
34         "Development Status :: 3 - Alpha",
35         "Topic :: Utilities",
36         "License :: OSI Approved :: GNU General Public License (GPL)",
37     ],
38     # 此项需要，否则卸载时报windows error
39     zip_safe=False
40 )