[toc] 使用Setuptools構建和分發軟體包 參考 "官方文檔" 翻譯 開發人員指南 安裝setuptools 安裝最新版本的setuptools： 基本使用 引入setuptools基本使用 要生成源代碼分發，只需調用： 隨著項目的增大將會包括一些依賴項，以及一些數據文件和腳本： 下麵我們 ...
目錄
使用Setuptools構建和分發軟體包
參考官方文檔翻譯
開發人員指南
安裝setuptools
安裝最新版本的setuptools：
python3 -m pip install --upgrade setuptools基本使用
引入setuptools基本使用
from setuptools import setup, find_packages
setup(
name="HelloWorld",
version="0.1",
packages=find_packages(),
)要生成源代碼分發，只需調用：
setup.py sdist隨著項目的增大將會包括一些依賴項，以及一些數據文件和腳本：
from setuptools import setup, find_packages
setup(
name="HelloWorld",
version="0.1",
packages=find_packages(),
scripts=["say_hello.py"],
# Project uses reStructuredText, so ensure that the docutils get
# installed or upgraded on the target machine
install_requires=["docutils>=0.3"],
package_data={
# If any package contains *.txt or *.rst files, include them:
"": ["*.txt", "*.rst"],
# And include any *.msg files found in the "hello" package, too:
"hello": ["*.msg"],
},
# metadata to display on PyPI
author="Me",
author_email="[email protected]",
description="This is an Example Package",
keywords="hello world example examples",
url="http://example.com/HelloWorld/", # project home page, if any
project_urls={
"Bug Tracker": "https://bugs.example.com/HelloWorld/",
"Documentation": "https://docs.example.com/HelloWorld/",
"Source Code": "https://code.example.com/HelloWorld/",
},
classifiers=[
"License :: OSI Approved :: Python Software Foundation License"
]
# could also include long_description, download_url, etc.
)下麵我們將解釋大多數這些setup() 參數的作用（元數據除外），以及在您自己的項目中使用它們的各種方式
指定項目的版本
官方的劃分比較多，簡潔的說一下：
版本：發行號+標簽（交替出現）
發行號：2.1.0 （簡單理解格式）
標簽：類似alpha，beta， a，c，dev等，例如：一個不穩定的預發行版本，建議：2.1.0.a9，如果需要加入日期建議使用-，例如：2.1.0.9-20190604
可以使用該pkg_resources.parse_version()功能比較不同的版本號：
>>> from pkg_resources import parse_version
>>> parse_version("1.9.a.dev") == parse_version("1.9a0dev")
True
>>> parse_version("2.1-rc2") < parse_version("2.1")
True
>>> parse_version("0.6a9dev-r41475") < parse_version("0.6a9")
True新增和更改的setup()關鍵字
include_package_data：如果設置為True，setuptools則表示將在MANIFEST.in文件指定的包目錄中自動包含找到的所有數據文件。
exclude_package_data：將包名稱映射到應該從包目錄中排除的全局模式列表的字典
package_data：字典將包名稱映射到全局模式列表。
zip_safe：一個布爾值（True或False）標誌，指定是否可以安全地安裝該項目並從zip文件運行該項目。如果未提供此參數，則bdist_egg每次構建雞蛋時，該命令將必須分析項目的所有內容以查找可能的問題。
install_requires：一個字元串或字元串列表，指定在安裝此版本時還需要安裝其他發行版。
entry_points：字典將入口點組名稱映射到定義入口點的字元串或字元串列表。
extras_require：字典將名稱“ extras”（項目的可選功能）映射到字元串或字元串列表的字典，用於指定必須安裝哪些其他發行版來支持這些功能。
python_requires：python版本設置。
版本號大於等於3.3，但是不能超過4
python_requires='~=3.3',
支持2.6 2.7以及所有以3.3開頭的Python 3版本
python_requires='>=2.6, !=3.0.*, !=3.1.*, !=3.2.*, <4',setup_requires：安裝腳本執行時需要依賴的分發包，主要用於構建過程，註意，這裡列出的包不會自動安裝，如果需要，同時要在install_requires中指定。
dependency_links：滿足依賴性時要搜索的URL的字元串列表
namespace_packages：命名項目的“命名空間包”的字元串列表
包括數據文件
對包含的文件進行更細粒度的控制（例如，如果您的軟體包目錄中有文檔文件，並希望將其排除在安裝範圍之外），則還可以使用package_data關鍵字
setup.py
src/
mypkg/
__init__.py
mypkg.txt
data/
somefile.dat
otherdata.datfrom setuptools import setup, find_packages
setup(
...
packages=find_packages("src"), # include all packages under src
package_dir={"": "src"}, # tell distutils packages are under src
package_data={
# If any package contains *.txt files, include them:
"": ["*.txt"],
# And include any *.dat files found in the "data" subdirectory
# of the "mypkg" package, also:
"mypkg": ["data/*.dat"],
}
)如果想去掉readm.md等文件：
from setuptools import setup, find_packages
setup(
...
packages=find_packages("src"), # include all packages under src
package_dir={"": "src"}, # tell distutils packages are under src
include_package_data=True, # include everything in source control
# ...but exclude README.txt from all packages
exclude_package_data={"": ["README.txt"]},
)參考示例
#!/usr/bin/env python
# -*- coding: UTF-8 -*-
from setuptools import setup, find_packages
"""
setuptools使用文檔: https://setuptools.readthedocs.io/en/latest/setuptools.html
生成源碼發佈包, 在靈犀工程目錄(LingXi/)下執行: python3 setup.py sdist
"""
setup(
name="LingXi",
version="1.5.0", # 發佈前註意將此處改為本次發佈的版本號
packages=find_packages(),
# Project uses reStructuredText, so ensure that the docutils get
# installed or upgraded on the target machine
# install_requires=['docutils>=0.3'],
package_data={
# If any package contains *.txt or *.rst files, include them:
'': ['*.txt', '*.otf', '*.ttc', '*.sh', '*.css', '*.js', '*.ttf', '*.eot', '*.svg', '*.woff'],
'perception': ['templates/*',
'blocks/econet/*.yaml',
'compiled/Makefile',
'compiled/center_net/_cpools/src/*.cpp', 'compiled/center_net/_nms/*.c',
'compiled/center_net/_nms//pointer/resnet50/*',
'modules/meter_recognition_v2/cfgs/*',
'modules/meter_recognition_v2/cfgs/resnet50/*',
],
'services': ['*.sh',
'lingxi/static/js/*.js', 'lingxi/static/audio/*.wav',
'lingxi/static/docs/*.pdf', 'lingxi/static/imgs/*.jpg',
'lingxi/static/*.html', 'lingxi/templates/*.html',
'lingxi/static/*.css', 'lingxi/static/*.ico']
},
# metadata to display on PyPI
author="",
author_email="",
maintainer="",
maintainer_email="{dzp, gy, xkk}@kilox.cn",
description="分析系統",
keywords="",
url="",
license="GPLv3",
platforms="UNIX",
long_description="README.md, CHANGELOG.md, LICENSE",
install_requires=['opencv-python', 'numpy', 'Pillow', 'six', 'torch', 'pytz', 'waitress', 'wtforms', 'flask',
'torchvision', 'termcolor', 'scipy', 'matplotlib', 'imageio', 'requests', 'soundfile', 'librosa',
'face_recognition', 'scikit-image', 'imutils', 'tensorflow', 'mmcv', 'pycocotools', 'tabulate',
'psutil', 'py-cpuinfo', 'PyYAML', 'fvcore']
)
