Setup.py 快速入门：如何创建和运行 Python 安装脚本-原创手记-慕课网

Setup.py：Python项目的安装与分发工具

在Python世界中，setup.py是一个非常重要的工具，它为Python项目的安装和分发提供了便捷的方式。本文将详细介绍setup.py的作用和使用方法，帮助程序员更高效地进行Python项目的开发和管理。

Setup.py简介

Setup.py是一个Python脚本，通常位于项目的根目录下。它定义了项目安装和分发所需的各种元数据，如项目名称、版本号、作者、依赖关系等。通过setup.py，程序员可以轻松地将Python项目打包成各种格式（如wheel、egg等），以便于在其他环境中使用。

Setup.py基本结构

一个基本的setup.py文件通常包含以下部分：

import setuptools

with open("README.md", "r") as fh:
    long_description = fh.read()

setuptools.setup(
    name="project_name",
    version="0.1.0",
    author="author_name",
    author_email="author_***",
    description="A short description of the project",
    long_description=long_description,
    long_description_content_type="text/markdown",
    url="***",
    packages=setuptools.find_packages(),
    install_requires=[
        "package1>=1.0.0",
        "package2>=2.0.0",
    ],
    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ]
)

Setup.py常用功能

定义项目信息

Setup.py的第一个作用是定义项目的基本信息，如项目名称、版本号、作者、依赖关系等。这些信息对于项目的分发和安装非常重要，可以帮助用户了解项目的功能和使用方式。

setuptools.setup(
    name="project_name",
    version="0.1.0",
    author="author_name",
    author_email="author_***",
    description="A short description of the project",
    long_description=long_description,
    long_description_content_type="text/markdown",
    url="***",
)

指定项目依赖

Setup.py的第二个作用是指定项目依赖。通过install_requires参数，程序员可以列出项目运行时所依赖的Python包和版本要求。这将帮助用户自动安装项目所需的依赖，提高项目的可移植性。

setuptools.setup(
    ...
    install_requires=[
        "package1>=1.0.0",
        "package2>=2.0.0",
    ],
    ...
)

打包和分发项目

Setup.py的第三个作用是打包和分发项目。通过setup.py，程序员可以使用setuptools提供的各种命令，如setup.py sdist（生成源代码分发包）、setup.py bdist_wheel（生成wheel分发包）等，将项目打包成不同的格式，以便于在其他环境中使用。

总结

Setup.py是Python项目中不可或缺的一部分，它为项目的安装和分发提供了便捷的方式。通过setup.py，程序员可以轻松地定义项目信息、指定项目依赖并打包和分发项目。因此，熟练掌握setup.py的使用方法对于Python程序员来说至关重要。