setup.py 是用于构建和安装 Python 包的脚本。它通常包含了一些元数据，如包的名称、版本、作者、依赖关系等。它还可以定义一些构建和安装相关的操作，如编译扩展模块、生成文档、定义命令行工具等。
下面是一个简单的 setup.py 的示例：
from setuptools import setup, find_packages
setup(
name='example_pkg',
version='0.1',
author='Your Name',
author_email='[email protected]',
description='An example Python package',
packages=find_packages(),
install_requires=[
'requests'
],
entry_points={
'console_scripts': [
'example=example_pkg.example:main'
]
}
)
在这个示例中，setup() 函数接收一系列关键字参数来定义包的元数据和行为。其中一些关键字参数的含义如下：
name: 包的名称。version: 包的版本号。author、author_email: 作者的名字和电子邮件地址。description: 包的简短描述。packages: 需要包含在包中的模块列表。可以通过find_packages()来自动发现所有的模块。install_requires: 依赖关系列表，指定了包需要的其他 Python 包。entry_points: 定义了命令行工具的入口点，可以直接在命令行中使用。
除此之外，还可以通过 setup() 函数的其他关键字参数来定义更多的元数据和定制行为，详细信息可以参考相关文档。
要使用 setup.py 来构建和安装包，可以在包的根目录下运行以下命令：
python setup.py build
python setup.py install
这将会编译包中的扩展模块（如果有的话），并将包安装到 Python 的环境中。可以根据需要添加其他命令和参数来定制构建和安装过程。