python项目打包whl文件

原创

mob64ca12e60047 2024-09-07 04:49:56 ©著作权

文章标签 Python bash 配置文件 文章分类 Python 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12e60047的原创作品，请联系作者获取转载授权，否则将追究法律责任

如何打包 Python 项目为 .whl 文件

打包 Python 项目为 .whl 文件的过程，虽然初看起来可能有些复杂，但只要掌握了步骤和每一步的细节，便能轻松上手。接下来，我将带你逐步了解这个流程，最终完成打包。

流程概述

步骤	描述
1	确保项目结构合理
2	创建 `setup.py` 文件
3	安装 `setuptools` 和 `wheel`
4	使用命令打包项目
5	验证打包结果

步骤详细解说

1. 确保项目结构合理

确保你的项目目录结构合理，通常应包含如下内容：

your_project/
|-- your_module/
|   |-- __init__.py
|   |-- your_code.py
|-- setup.py
|-- README.md

在这个结构中，your_module 是你的主代码包，setup.py 是用于打包的配置文件，README.md 是项目的简介。

2. 创建 `setup.py` 文件

setup.py 是 Python 项目的打包配置文件。接下来创建这个文件，并填写必要的信息。

from setuptools import setup, find_packages

setup(
    name='your_project_name',  # 项目名称
    version='0.1.0',           # 项目版本
    packages=find_packages(),   # 查找包
    install_requires=[          # 依赖包
        # 'package_name', # 在这里填写项目依赖的包
    ],
    author='Your Name',         # 作者
    author_email='your_email@example.com',  # 作者邮箱
    description='A brief description of your project',  # 项目描述
    long_description=open('README.md').read(),  # 详细描述
    long_description_content_type='text/markdown',  # 描述格式
    url='  # 项目链接
)

在这里，你需要替换相关的项目名称、版本、依赖等信息。文件里的每一项都被具体注释，以帮助你理解其用途。

3. 安装 `setuptools` 和 `wheel`

在进行打包之前，你需要确保已安装 setuptools 和 wheel 这两个库。你可以在终端中运行以下命令：

pip install setuptools wheel

这条命令会安装这两个包，它们在打包过程中起到关键作用。

4. 使用命令打包项目

现在，我们可以开始打包了。要在项目根目录下使用以下命令：

python setup.py sdist bdist_wheel

sdist 表示发布源代码包。
bdist_wheel 表示创建一个 wheel 包。

这两条命令会在项目目录下生成一个名为 dist 的文件夹，里面就包含了 .whl 文件。

5. 验证打包结果

打包完成后，你可以查看 dist 文件夹，确保里面有你的 .whl 文件。例如：

ls dist/

这条命令会列出 dist 文件夹的内容，确认 .whl 文件是否存在。

关系图示例

erDiagram
    PROJECT {
        string name
        string version
        string description
    }
    AUTHOR {
        string name
        string email
    }
    PROJECT ||--o{ AUTHOR : written_by

在这个简单的关系图中，我们可以看到项目与作者之间的关系。每个项目由某个作者撰写，包含项目的名称、版本和描述信息。