python中自动化部署setup.py的写法

编写python的第三方库，最重要的一个工作就是编写setup.py了，如果我们下载过一些第三库的源代码文件，打开之后一般就会有一个setup.py,执行python setup.py install 就可以安装这个库了。setup.py 如何编写内容很多，可以参考官方文档：https://wiki.python.org/moin/Distutils/Tutorial?highlight=%28setup.py%29。

一个典型的setup.py的写法如下(参考自官方文档):

from distutils.core import setup

#这是一个和根目录相关的安装文件的列表，列表中setup.py更具体)

files = ["things/*"]

setup(name = "appname",
    version = "100",
    description = "yadda yadda",
    author = "myself and I",
    author_email = "[email protected]",
    url = "whatever",
    #Name the folder where your packages live:
    #(If you have other packages (dirs) or modules (py files) then
    #put them into the package directory - they will be found recursively.)
    packages = ['package'],
    #'package' package must contain files (see list above)
    #I called the package 'package' thus cleverly confusing the whole issue...
    #This dict maps the package name =to=> directories
    #It says, package *needs* these files.
    package_data = {'package' : files },
    #'runner' is in the root.
    scripts = ["runner"],
    long_description = """Really long text here.""" 
    #
    #This next part it for the Cheese Shop, look a little down the page.
    #classifiers = []     
)

建立一个名字叫setup.py的文件， 从distutils.core 导入 setup, 然后编写 setup()函数，这个函数里面有相当多的属性，如果是正规的开发，所有这些东西都应该按照规范去写。其中比较重要的几个选项：

• version ：版本号，
• description ：描述文档，
• author：作者，
• name：模块的名称。
• packages：包所在的目录，如果我们要打包的所有python文件都在根目录，即和setup.py是一个目录，那么直接写 packages=[""]就可以了。如果python文件在一个单独的文件夹，和setup.py不在同一个目录，则需要写 package_dir=[""："python 文件所在的目录名字"],比如如果有foo1.py 和 foo2.py这两个文件，在src这个文件夹，那么需要写package_dir=["":"src"],同时写packages=[""],打包就可以导入foo1和foo2两个模块了。如果想在同一个包中包含多个模块，比如在foo包中包含foo1和foo2两个模块，则可以直接把foo1.py和foo2.py所在的文件夹直接命名为foo,然后写 packages["foo"] (注意foo文件夹需要有__init__.py这个文件，可以为空，这样才能引用到foo1和foo2)。
• 其他还有很多写法，这篇博文总结的很好，http://www.cnblogs.com/UnGeek/p/5922630.html。

有时我们写的代码需要引入一些额外的信息文件，比如文本文件，或者图片，说明文件等等，这些东西是需要一块打包的，那么这个时候该如何指定呢？此时需要用到 data_files 这个选项了。

• data_files的写法是:data_files= [('文件要放入的文件夹1',['file1',file2']),('文件要放入的文件夹2',['file3',file4'])],file1,file2等是文件的名称，注意data_files的元素都是元组，元组的第一个元素是文件要放入的文件夹名称，第二个元素是文件列表。这里需要注意的是，如果不想把文件放入文件夹，可以将元组的第一个元素指定为空字符串，此时要打包的文件要被放入根目录，这里根目录是指python解释器所在的目录。比如我需要将文件资源放入python解释器所在目录下的/Lib/site-packages/myfolder路径，myfolder是自定义的文件夹，元组的第一个元素就可以写‘Lib/site-packages/myfolder’，打包时会自动在指定位置新建一个名为myfolder的目录，将文件资源放入其中。

其实 setup.py 文件的编写还有非常多的内容，这里只是介绍了九牛一毛。后面接触到了更复杂的再继续补充吧。具体还是要参考官方文档。

打包命令：

http://blog.csdn.net/lynn_kong/article/details/17540207

简单来说，linux下的打包命令是：python setup.py sdist 为模块创建一个源码包。在windows下，可以使用 python setup.py bdist_wininst 生成一个exe文件。双击该exe文件，就会弹出python库的安装界面（就是经典的蓝色界面），可以自己选择要安装的位置（特别是电脑中有多个版本的python的时候，需要指定这个库装到哪个python库目录下），一路下一步，就安装成功了。此时去指定的python库目录下，就会发现多出了一些我们自己安装的文件以及文件夹。此时试着import一下，就会发现已经可以导入我们自己的模块了。

推荐阅读：https://blog.csdn.net/pfm685757/article/details/48651389

1、packages
告诉Distutils需要处理那些包（包含__init__.py的文件夹）
2、package_dir
告诉Distutils哪些目录下的文件被映射到哪个源码包。一个例子：package_dir = {'': 'lib'}，表示“root package”中的模块都在lib目录中。
3、ext_modules
是一个包含Extension实例的列表，Extension的定义也有一些参数。
4、ext_package
定义extension的相对路径
5、requires
定义依赖哪些模块
6、provides
定义可以为哪些模块提供依赖
7、scripts
指定python源码文件，可以从命令行执行。在安装时指定--install-script
8、package_data
通常包含与包实现相关的一些数据文件或类似于readme的文件。如果没有提供模板，会被添加到MANIFEST文件中。
9、data_files
指定其他的一些文件（如配置文件）