Setuptools 是一个用于 Python 的包管理工具，主要用于构建、打包和分发 Python 软件包。它是 distutils 的增强版，提供了更多的功能和灵活性，是 Python 包管理的核心模块之一。
功能与特点
- 依赖管理：Setuptools 提供了强大的依赖管理功能，可以自动解析和安装软件包所需的依赖项。
- 自动生成入口点：它能够自动发现并生成命令行脚本的入口点，例如将 Python 脚本转换为可执行文件。
- 模块发现：通过
find_packages()函数，Setuptools 可以自动发现并包含所有包含__init__.py文件的目录。 - 打包与分发：Setuptools 支持创建多种格式的包，包括 wheel、sdist 和 egg 等，并可以通过 pip 等工具进行分发。
- 扩展支持：它允许开发者通过扩展（如
setuptools.command）来添加自定义构建步骤或命令。 - 元数据管理：通过
setup.py文件，开发者可以定义软件包的元数据，如名称、版本、作者信息等。
安装方法
Setuptools 可以通过 pip 安装：
pip install setuptools
安装完成后，可以通过以下命令验证是否安装成功：
pip list | grep setuptools
通常情况下，安装 Python 和 pip 后，setuptools 会默认自带。
使用场景
- 打包与发布：开发者可以使用 setuptools 将自己的代码打包成一个可安装的 Python 包，并上传到 PyPI（Python Package Index）供他人下载和使用。
- 依赖管理：在项目中，可以通过
setup.py文件指定项目所需的依赖包，并在运行时自动安装这些依赖。 - 自动化构建：通过编写
setup.py脚本，可以实现自动化构建、安装和发布的过程。
常用命令
python setup.py build：构建项目。python setup.py install：安装项目。python setup.py sdist：生成源码包。python setup.py bdist_wheel：生成 wheel 包。
示例代码
以下是一个简单的 setup.py 文件示例：
from setuptools import setup, find_packagessetup(name="example",version="0.1",packages=find_packages(),install_requires=["numpy","scipy"],entry_points={"console_scripts": ["example = example.__main__:main"]}
)
在这个示例中，find_packages() 自动发现并包含所有模块，install_requires 指定了依赖项，entry_points 定义了命令行脚本。
Setuptools 是 Python 开发中不可或缺的工具之一，它简化了包的构建、分发和管理过程。无论是个人开发者还是企业用户，都可以通过它高效地管理和发布 Python 软件包。
要使用Setuptools创建包含多个子包的复杂Python项目，可以按照以下步骤进行：
- 创建项目结构：
首先，创建一个项目目录，并在其中创建子包。每个子包应该包含一个__init__.py文件，即使该文件为空。例如：
my_project/├── setup.py ├── my_project/│ ├── __init__.py│ ├── subpackage1/│ │ ├── __init__.py│ │ └── module1.py │ └── subpackage2/│ ├── __init__.py│ └── module2.py
- 编写setup.py文件：
setup.py是Setuptools的核心配置文件，用于定义项目的元数据和打包选项。对于包含多个子包的项目，可以使用find_packages()函数自动发现所有子包。以下是一个示例setup.py文件：
from setuptools import setup, find_packagessetup(name='my_project',version='0.1',packages=find_packages(),install_requires=['requests','numpy',# 其他依赖项],author='你的名字',author_email='你的邮箱',description='项目的简短描述',long_description=open('README.md ').read(),long_description_content_type='text/markdown',url='项目的URL',classifiers=['Development Status :: 3 - Alpha','Intended Audience :: Developers','License :: OSI Approved :: MIT License','Programming Language :: Python :: 3','Programming Language :: Python :: 3.6','Programming Language :: Python :: 3.7','Programming Language :: Python :: 3.8','Programming Language :: Python :: 3.9',],python_requires='>=3.6',)
在这个示例中，find_packages()函数会自动查找并包含所有子包。install_requires参数用于指定项目的依赖项。
-
创建README.md文件：
README.md文件用于提供项目的详细描述，可以使用Markdown格式编写。这个文件的内容会被读取并显示在PyPI页面上。 -
构建和发布项目：
使用build工具来构建项目。首先，确保已经安装了build工具：
pip install build
然后，运行以下命令来构建项目：
python -m build
构建完成后，会在项目目录下生成一个dist文件夹，其中包含.tar.gz和.whl文件，即Python包。
- 发布到PyPI：
使用twine工具将构建好的包发布到PyPI。首先，确保已经安装了twine工具：
pip install twine
然后，运行以下命令来发布包：
twine upload dist/*
运行上述命令后，会提示你输入PyPI的用户名和密码。发布成功后，其他人就可以通过pip install my_project来安装你的项目了。
通过以上步骤，你可以使用Setuptools创建并发布一个包含多个子包的复杂Python项目。
