setup()
函数是 Python 中 setuptools
库的一个关键函数,用于从 Python 包中分发和安装代码
name
(str): 包的名称,必须是小写字母,可以包含字母、数字、破折号和下划线。这是包的唯一标识符,当你在 Python 环境中导入该包时,会使用此名称。
version
(str): 包的版本号,遵循 Semantic Versioning 规范。这个版本号可以帮助用户了解包的更新情况,以及在进行依赖管理时做出明智的决策。
description
(str, optional): 包的简短描述。这个描述应该简洁明了地概括了包的功能和用途。
long_description
(str, optional): 包的详细描述。这个描述应该包含更多关于包的功能、用途和实现细节的信息。通常,这个描述是从 README.md
文件中读取的。
long_description_content_type
(str, optional): 详细描述的格式,例如 text/markdown
。这个参数告诉 Python 如何解析详细描述的内容。默认值为 text/plain
。
url
(str, optional): 包的官方网站或代码仓库的 URL。这个 URL 可以让用户找到更多关于包的信息,如文档、示例和常见问题解答。
author
(str, optional): 包的作者的名字或姓名。这个参数可以是一个字符串,也可以是一个包含多个作者的列表。
author_email
(str, optional): 包作者的电子邮件地址。这个参数可以是一个字符串,也可以是一个包含多个电子邮件地址的列表。
license
(str, optional): 包所使用的许可证。这个参数可以是一个字符串,也可以是一个包含多个许可证的列表。
packages
(list, optional): 要包含在分发包中的 Python 模块和子包的列表。默认情况下,setuptools
会自动检测所有包含 __init__.py
文件的目录。
package_dir
(dict, optional): 一个字典,用于指定源代码目录与包名称之间的映射关系。这个参数可以帮助你组织复杂的包结构。
install_requires
(list, optional): 列出包所需的依赖项。这些依赖项可以是其他包或 Python 库。当用户安装此包时,这些依赖项将自动安装。
dependency_links
(list, optional): 一个包含依赖项链接的列表。这些链接可以是 Git 仓库、HTTP URL 或文件系统路径。这个参数允许用户在安装此包时直接从指定的位置安装依赖项。
extras_require
(dict, optional): 一个字典,其中键是可选的组名,值是包含该组所需依赖项的列表。这个参数允许用户根据需要安装特定组的依赖项。
entry_points
(dict, optional): 一个字典,用于定义命令行接口(CLI)的入口点。这个参数可以让你创建自定义命令或脚本,以便用户可以从命令行运行你的包。
scripts
(list, optional): 一个包含要安装为可执行文件的脚本名称的列表。这些脚本通常位于 bin
目录中,并在安装此包时自动创建。
data_files
(list, optional): 一个包含要安装为系统文件的列表。这些文件通常位于 share
目录中,并在安装此包时自动创建。
classifiers
(list, optional): 一个包含关于包的元数据的列表。这些元数据可以帮助用户在 Python Package Index(PyPI)上搜索和过滤包。
python_requires
(str, optional): 指定支持的 Python 版本范围。这个参数可以使用以下符号:>=
(大于等于)、==
(等于)、!=
(不等于)、<
(小于)和 >
(大于)。
zip_safe
(bool, optional): 如果设置为 True
,则将包打包为一个 ZIP 文件。默认值为 False
,这意味着包将被安装为多个目录和文件。
这只是 setup()
函数参数的简要概述。要了解更多详细信息,请参阅 setuptools 文档。