完成源码后将代码打成安装包:
1. 我的源代码结构如下:
pack
|---src
| - common ---http
---user
| - lib
| - factory.py
2. 实现setup.py
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
from distutils.core import setup
setup(
name='sdk',
version='1.0',
description='sdk for di input , output and param',
author='sam',
author_email='sam@qq.com',
url='',
license='No License',
platforms='python 2.7',
py_modules=['factory'],
package_dir={'': 'pack'},
packages=['lib', 'common.http']
)
执行
python setup.py sdist
setup.py 同级目录生成一个dist文件夹,里面是 sdk1.0.tar.gz
之后就可以解压
解压后安装:
python setup.py install
注:使用 setup.py没有卸载功能,如果需要卸载则要手动删除
也可使用: -- record 记录安装文件的目录
python setup.py install --record file.txt
卸载就可以使用脚本,实现自动安装和卸载
注 1:
setup.py参数说明
#python setup.py build # 编译
#python setup.py install #安装
#python setup.py sdist #生成压缩包(zip/tar.gz)
#python setup.py bdist_wininst #生成NT平台安装包(.exe)
#python setup.py bdist_rpm #生成rpm包
或者直接"bdist 包格式"，格式描述如下：
#python setup.py bdist --help-formats
--formats=rpm RPM distribution
--formats=gztar gzip'ed tar file
--formats=bztar bzip2'ed tar file
--formats=ztar compressed tar file
--formats=tar tar file
--formats=wininst Windows executable installer
--formats=zip ZIP file
注2: setup参数:
- name 打包名称
- version 版本
- ....
- playforms 所支持的平台 ,例中只支持2.7
- package_dir 源码所在目录
- packages 源码目录下那些目录要被打包
- py_modules 需要打包的模块
- requires 定义依赖模块
- ...
具体参数可参见官网
引用:
https://docs.python.org/2/distutils/apiref.html
http://blog.csdn.net/langb2014/article/details/53114341
https://www.cnblogs.com/yunfeiqi/p/6844771.html
补充：
一、构建工具setup.py的应用场景
在安装python的相关模块和库时，我们一般使用“pip install 模块名”或者“python setup.py install”，前者是在线安装，会安装该包的相关依赖包；后者是下载源码包然后在本地安装，不会安装该包的相关依赖包。所以在安装普通的python包时，利用pip工具相当简单。但是在如下场景下，使用python setup.py install会更适合需求：
在编写相关系统时，python 如何实现连同依赖包一起打包发布？ 假如我在本机开发一个程序，需要用到python的redis、mysql模块以及自己编写的redis_run.py模块。我怎么实现在服务器上去发布该系统，如何实现依赖模块和自己编写的模块redis_run.py一起打包，实现一键安装呢？同时将自己编写的redis_run.py模块以exe文件格式安装到python的全局执行路径C:\Python27\Scripts下呢？ |
在这种应用场景下，pip工具似乎派不上了用场，只能使用python的构建工具setup.py了，使用此构建工具可以实现上述应用场景需求，只需在 setup.py 文件中写明依赖的库和版本，然后到目标机器上使用python setup.py install安装。
二、setup.py介绍
1 from setuptools import setup, find_packages
2
3 setup(
4 name = "test",
5 version = "1.0",
6 keywords = ("test", "xxx"),
7 description = "eds sdk",
8 long_description = "eds sdk for python",
9 license = "MIT Licence",
10
11 url = "http://test.com",
12 author = "test",
13 author_email = "[email protected]",
14
15 packages = find_packages(),
16 include_package_data = True,
17 platforms = "any",
18 install_requires = [],
19
20 scripts = [],
21 entry_points = {
22 'console_scripts': [
23 'test = test.help:main'
24 ]
25 }
26 )
setup.py各参数介绍：
--name 包名称 其实我们可以将包统一放在一个src目录中，另外，这个包内可能还有aaa.txt文件和data数据文件夹。另外，也可以排除一些特定的包 find_packages(exclude=["*.tests", "*.tests.*", "tests.*", "tests"]) --install_requires = ["requests"] 需要安装的依赖包 |
下列entry_points中： console_scripts 指明了命令行工具的名称；在“redis_run = RedisRun.redis_run:main”中，等号前面指明了工具包的名称，等号后面的内容指明了程序的入口地址。
1 entry_points={'console_scripts': [
2 'redis_run = RedisRun.redis_run:main',
3 ]}
这里可以有多条记录，这样一个项目就可以制作多个命令行工具了，比如：
1 setup(
2 entry_points = {
3 'console_scripts': [
4 'foo = demo:test',
5 'bar = demo:test',
6 ]}
7 ）
三、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安装时使用的名称，或生成egg文件的名称
12 version="1.0",
13 author="Andreas Schroeder",
14 author_email="[email protected]",
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=['RedisRun'], # 需要打包的目录列表
20
21 # 需要安装的依赖
22 install_requires=[
23 'redis>=2.10.5',
24 'setuptools>=16.0',
25 ],
26
27 # 添加这个选项，在windows下Python目录的scripts下生成exe文件
28 # 注意：模块与函数之间是冒号:
29 entry_points={'console_scripts': [
30 'redis_run = RedisRun.redis_run:main',
31 ]},
32
33 # long_description=read('README.md'),
34 classifiers=[ # 程序的所属分类列表
35 "Development Status :: 3 - Alpha",
36 "Topic :: Utilities",
37 "License :: OSI Approved :: GNU General Public License (GPL)",
38 ],
39 # 此项需要，否则卸载时报windows error
40 zip_safe=False
41 )
四、修改后的项目代码（此时RedisRun模块是DrQueue模块的子模块，这是因为要导入某些公用的模块）
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="[email protected]",
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 )
此时项目的目录结构为：
参考博客：
http://blog.csdn.net/lynn_kong/article/details/17540207
http://blog.csdn.net/pfm685757/article/details/48651389
http://blog.csdn.net/langb2014/article/details/53
https://www.cnblogs.com/maociping/p/6633948.html