【python基础】理解 Python 的 setup.py文件：打包和分发的核心

引言

在 Python 项目开发中，打包和分发是一项重要任务，特别是当您想要与全球的开发者共享您的作品时。这正是 setup.py 文件闪耀登场的时刻。本文旨在探讨 setup.py 文件的作用、结构以及如何高效地使用它来管理您的 Python 包。

setup.py 文件简介

setup.py 是一个用于定义、构建、打包和安装 Python 包的脚本。位于项目的根目录下，这个文件用于告诉 Python 包管理工具如 setuptools 您的包的详细信息。从包的基本信息到依赖管理，setup.py 是管理包生命周期的核心。

导入 setuptools

导入 setuptools 库：

from setuptools import setup, find_packages

setuptools 库提供了打包 Python 项目所需的功能，包括 setup 函数，它是 setup.py 的核心。

setup() 函数

setup() 函数是打包和分发过程的核心，定义了包的属性和配置。以下是一个标准的 setup() 函数示例：

setup(
    name="example_package",
    version="0.1",
    description="An example Python package",
    long_description=open('README.md').read(),
    url="https://example.com/project",
    author="Author Name",
    author_email="author@example.com",
    packages=find_packages(),
    install_requires=[
        'numpy',
        'requests',
    ],
    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
    python_requires='>=3.6',
)

主要字段详解

• name 和 version: 包的名称和版本，是包的唯一标识。
• description 和 long_description: 简短和详细的包描述。
• url: 项目的官方网站，通常是代码仓库的链接。
• author 和 author_email: 包作者的名称和邮箱地址。
• packages: 使用 find_packages() 自动找到所有应该包含的包。
• install_requires: 列出项目的依赖项。
• classifiers: 提供关于包的元数据。
• python_requires: 指定项目所需的 Python 版本。

使用 setup.py

一旦您的 setup.py 文件准备好了，您可以使用多种命令来执行不同的操作，如安装包、打包和上传到 PyPI。

例如，安装包可以简单地使用以下命令：

python setup.py install

结语

虽然新的包管理工具如 Poetry 和 Flit 的出现可能会改变 Python 包管理的景象，但 setup.py 仍然是当前许多 Python 项目不可或缺的一部分。理解和掌握 setup.py 对于任何希望分享其 Python 项目的开发者来说都是一个宝贵的技能。

---

希望这篇文章能够帮助您更好地理解和使用 setup.py 文件，从而更有效地管理您的 Python 项目。欢迎在评论区分享您对 setup.py 的看法和经验，让我们共同成长！

作者：[climber1121]
链接：https://blog.csdn.net/climber1121
来源：CSDN
版权声明：本文为博主原创文章，转载请附上原文出处链接和本声明。