将python打包成可引入包

原创

mob649e816138f5 2024-08-06 08:10:54 ©著作权

文章标签 Python bash 安装包 文章分类 Python 后端开发

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

将 Python 打包成可引入包

在 Python 开发中，打包是一个重要的步骤，这样你就可以将你的项目以库的形式分享或者再利用。本文将详细介绍如何将 Python 项目打包成可引入的包，包括每一步的详细操作和示例代码。

流程概览

首先，我们来看一下简单的流程概览。下表展示了从创建包到发布的步骤：

步骤	操作
1	创建项目目录
2	编写 `setup.py` 文件
3	创建包目录和模块
4	编写 `__init__.py` 文件
5	构建和安装包
6	发布到 PyPI（可选）

每一步的详细操作

1. 创建项目目录

首先，创建一个新的目录作为你的项目基础。在命令行中执行：

mkdir my_package
cd my_package

2. 编写 `setup.py` 文件

在项目目录中创建一个名为 setup.py 的文件，这个文件是用来描述你的包的元数据。

# setup.py
from setuptools import setup, find_packages

setup(
    name="my_package",  # 包名
    version="0.1",     # 版本号
    packages=find_packages(),  # 自动找到包
    install_requires=[],  # 依赖包
)

这个文件包含了包的基本信息，比如包名和版本号。

3. 创建包目录和模块

现在我们需要创建一个目录来存放具体的代码。执行以下命令：

mkdir my_package

在里面创建一个 Python 文件。比如我们创建了一个名为 mymodule.py 的模块。

# my_package/mymodule.py
def hello():
    print("Hello from my_package!")

4. 编写 `init.py` 文件

在包目录中创建一个 __init__.py 文件，该文件可为空。允许 Python 识别该目录为一个包。

touch my_package/__init__.py

此文件可以包含导入语句，例如：

# my_package/__init__.py
from .mymodule import hello  # 导入模块

5. 构建和安装包

回到项目根目录，使用以下命令构建包：

python setup.py sdist bdist_wheel

这将创建一个 dist 目录，里面包含构建好的包。要安装包，可以执行：

pip install .

6. 发布到 PyPI（可选）

如果你想要发布你的包到 PyPI，可以使用以下命令：

首先，确保你已注册了 PyPI 账户并安装了 twine：

pip install twine

然后，在项目根目录下执行以下命令：

twine upload dist/*

状态图

以下是应用包打包过程的状态图：

stateDiagram
    [*] --> 创建项目目录
    创建项目目录 --> 编写 setup.py
    编写 setup.py --> 创建包目录和模块
    创建包目录和模块 --> 编写 __init__.py
    编写 __init__.py --> 构建和安装包
    构建和安装包 --> 发布到 PyPI
    发布到 PyPI --> [*]