Python打包分发：编写setup.py指南

Python打包和分发是一个重要的步骤，用于分享你的Python项目。setup.py是一个构建和安装Python模块的脚本。以下是创建setup.py文件的基本指南。

setup.py的结构

setup.py通常包含以下几个部分：

1. 导入setup函数

   from setuptools import setup, find_packages
   

2. 配置包信息

   setup(
       name="包名",
       version="版本号",
       author="作者",
       author_email="作者邮箱",
       description="一句话描述",
       long_description="长描述",
       long_description_content_type="text/markdown",
       url="项目URL",
       packages=find_packages(),
       classifiers=[
           "Programming Language :: Python :: 3",
           "License :: OSI Approved :: MIT License",
           "Operating System :: OS Independent",
       ],
       python_requires='>=3.6',
       install_requires=[
           "依赖包1",
           "依赖包2",
       ],
   )
   

重要字段说明

• name: 包的名字。
• version: 包的版本。
• author 和 author_email: 包作者的名字和邮箱。
• description: 简短的包描述。
• long_description: 包的详细描述。通常从README文件读取。
• long_description_content_type: 长描述的内容类型，通常是"text/markdown"或"text/plain"。
• url: 项目主页的URL。
• packages: 定义项目中的包。
• classifiers: 包的分类信息。
• python_requires: 指定支持的Python版本。
• install_requires: 列出运行该包所需的依赖。

示例

以下是一个简单的setup.py示例：

from setuptools import setup, find_packages

setup(
    name="example_package",
    version="0.1",
    author="Your Name",
    author_email="your.email@example.com",
    description="A small example package",
    long_description="A longer description of your package",
    long_description_content_type="text/markdown",
    url="https://github.com/your/project",
    packages=find_packages(),
    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
    python_requires='>=3.6',
    install_requires=[
        "requests",
        "numpy",
    ],
)

结论

正确编写setup.py是确保你的Python包可以被其他开发者容易地安装和使用的关键。它不仅包括项目的基本信息，还包括依赖管理和环境配置。

---

以上即为编写Python包的setup.py文件的基础指南。