- 源碼包：python setup.py install
- 在線安裝：pip install 包名（linux） / easy_install 包名(window)
python包在開發中十分常見，通常的使用套路是全部的功能作一個python模塊包，打包模塊，而後發佈，安裝使用。打包和安裝包就是最多見的工做。學習中遇到distutils和setuptools兩種打包的工具，學習以後作筆記記錄。linux
distutils
distutils 是 python 標準庫的一部分，這個庫的目的是爲開發者提供一種方便的打包方式， 同時爲使用者提供方便的安裝方式。當咱們開發了本身的模塊以後，使用distutils的setup.py打包。git
1、完成功能python瀏覽器
hello.py安全
|
1
2
|
def hello_fun():
print
"i say hello to you"
|
2、創建setup.py文件dom
setup.pysvn
|
1
2
3
4
5
6
7
8
9
|
from
distutils.core import setup
setup(
name=
"hello_module"
,
version=
"1.0"
,
author=
"ljk"
,
author_email=
"wilber@sh.com"
,
py_modules=[
'hello'
],
)
|
3、執行打包命令函數
|
1
|
python setup sdist
|
再次查看當前目錄下自動生成了一個文件夾dist，文件夾中有一個壓縮包即爲咱們的目標文件。另外有一個記錄文件MANIFEST。工具
4、安裝模塊post
hello_module-1.0.tar.gz 是生成的python模塊。切換到的個人python虛擬環境中，安裝該模塊。
使用python setup.py install 安裝該模塊。從路徑能夠看出，該模塊安裝到標準庫的制定路徑下。
5、使用模塊
安裝好模塊以後，在python的交互環境中導入模塊。模塊就是hello.py文件，引用hello.py文件中的hello_fun()函數。
setuptools
setuptools是distutils的加強版。setuptools有一個entry_points功能很方便，相似linux啓動某個服務，如在linux命令行裏firefox能啓動火狐瀏覽器。
首先檢驗沒有安裝以前，命令path沒有做用。
1、建立功能包
建立一個文件夾demo，在文件夾裏建立get_path.py和__init__.py兩個文件。get_path.py是功能函數，__init__.py是包的標識文件。
get_path.py
|
1
2
3
4
5
|
import os
def fun():
print
"i am in the path:"
print os.getcwd()
|
2、配置setup.py文件
建立setup.py文件，填寫必要的打包信息。
setup.py
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
#-*- encoding: UTF-8 -*-
from
setuptools import setup
setup(
name =
"demo"
, # 包名
version =
"0.1"
, # 版本信息
packages = [
'demo'
], # 要打包的項目文件夾
include_package_data=True, # 自動打包文件夾內全部數據
zip_safe=True, # 設定項目包爲安全，不用每次都檢測其安全性
install_requires = [ # 安裝依賴的其餘包（測試數據）
'docutils>=0.3'
,
'requests'
,
],
# 設置程序的入口爲path
# 安裝後，命令行執行path至關於調用get_path.py中的fun方法
entry_points={
'console_scripts'
:[
'path = demo.get_path:fun'
]
},
)
<br><br>
|
在配置中將該模塊須要的依賴所有都寫好，安裝時指定地址去下載。這種方式簡化了使用時的安裝過程，可是還不夠好。最好的方式是pip的自動下載。
3、打包
|
1
|
python setup.py sdist
|
打包以後多出兩個文件夾，分別是demo.egg-info和dist。demo.egg-info是必要的安裝信息，而dist中的壓縮包就是安裝包。
查看dist/demo-0.1.tar.gz解壓以後的文件。
4、安裝包
5、使用包
安裝以後在命令行中直接輸入path，回車可以看到調用了get_path.py中的函數fun()，輸出字符串。
同時也能夠導入使用。
setuptools的進階使用
上面使用setuptools時只是簡單的用一個配置文件setup.py就完成了打包信息填寫。在真實的開發環境中，每每是多個文件配合。以openstack的打包爲例。openstack中引入了Pbr的管理工具。
pbr是setuptools的輔助工具，最初爲openstack開發，基於d2to1。Pbr會讀取和過濾setup.cfg中的內容，而後將解析後的數據提供給setup.py做爲參數。 setup.cfg提供setup.py的默認參數，同時易於修改。Setup.py先解析setup.cfg文件，而後執行相關命令。包括如下功能： 一、從git中獲取Version，AUTHORS和ChangeLog信息 二、SphinxAutodoc。pbr會掃描project，找到全部模塊，生成stubfiles 三、Requirements。讀取requirements.txt文件，生成setup函數須要依賴包 四、long_description。從README.rst、README.txt或者READMEfile中生成long_description參數
Pbr的文件很簡單，以下。配置以後會自動尋找目錄下的setup.cfg文件，解析文件參數給setup.py使用。
setup.py
|
1
2
3
4
5
6
7
8
|
from
setuptools import setup
setuptools.setup(
setup_requires=[
'pbr'
],
pbr=True)
|
setup.cfg
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
[metadata]
name= keystone
version= 2015.2
summary= OpenStack Identity
description-file=
README.rst
author= OpenStack
author-email= openstack-dev@lists.openstack.org
home-page= http:
//www.openstack.org/
classifier=
Environment:: OpenStack
IntendedAudience :: Information Technology
IntendedAudience :: System Administrators
License:: OSI Approved :: Apache Software License
OperatingSystem :: POSIX :: Linux
ProgrammingLanguage :: Python
ProgrammingLanguage :: Python :: 2
ProgrammingLanguage :: Python :: 2.7
[files]
packages=
keystone
[global]
setup-hooks=
pbr.hooks.setup_hook
[egg_info]
tag_build=
tag_date= 0
tag_svn_revision= 0
[build_sphinx]
all_files= 1
build-dir= doc/build
source-dir= doc/source
[compile_catalog]
directory= keystone/locale
domain= keystone
|