python3 开源安装包

原创

mob64ca12e3dd9e 2025-02-23 07:31:59 ©著作权

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

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

如何创建和发布 Python 3 开源安装包

在这个数字化的时代，开源软件已经成为了开发社区的一个重要组成部分。如果你是一位刚入行的小白，想要学习如何创建你的第一个 Python 3 开源安装包，那么你来对地方了。本文将带你详细了解整个过程，包括每一步需要做的事情和代码示例，以及一些额外的可视化工具。

整体流程

下面是创建和发布 Python 3 开源安装包的总体流程：

步骤	描述
1. 创建项目文件夹	创建用于存放项目的文件夹
2. 编写代码	在文件夹中编写 Python 代码
3. 创建 `setup.py`	创建安装包配置文件
4. 添加必要文件	编写 `README`, `LICENSE`, 等文件
5. 打包代码	使用工具将代码打包
6. 发布到 PyPI	将包发布到 Python 包索引

步骤详解

1. 创建项目文件夹

首先，你需要一个文件夹来存放你的项目文件。你可以在命令行中使用以下命令：

mkdir my_first_package  # 创建一个名为 my_first_package 的文件夹
cd my_first_package     # 进入该文件夹

2. 编写代码

在这个文件夹中创建一个 Python 文件 my_module.py 来编写你的代码。例如：

# my_module.py
def hello_world():
    """打印 Hello, World!"""
    print("Hello, World!")

这段代码定义了一个简单的函数，打印出 "Hello, World!"。

3. 创建 `setup.py`

setup.py 是用来配置安装包的脚本。在项目文件夹中创建 setup.py 文件，并添加以下内容：

# setup.py
from setuptools import setup, find_packages

setup(
    name='my_first_package',         # 包的名字
    version='0.1',                   # 版本号
    packages=find_packages(),         # 自动查找包
    install_requires=[],              # 依赖库
    author='Your Name',               # 作者名字
    author_email='you@example.com',   # 作者邮箱
    description='A simple Hello World package',  # 简短描述
    license='MIT',                    # 许可证
)

4. 添加必要文件

接下来，我们需要创建一些其他文件，例如 README.md 和 LICENSE。

**创建 README.md**：

# My First Package

This package is a simple example of a Hello World package in Python.

## Installation

```bash
pip install my_first_package

Usage

from my_module import hello_world

hello_world()


**创建 `LICENSE`**：

可以选择使用 MIT 许可证，你可以在网上找到 MIT 许可证的文本并将其复制到 `LICENSE` 文件中。

### 5. 打包代码

在项目文件夹中，使用以下命令来打包你的代码：

```bash
python3 setup.py sdist bdist_wheel  # 打包源码和生成 wheel 文件

执行完毕后，你的代码将被打包到 dist 文件夹中。

6. 发布到 PyPI

最后，你可以使用 twine 上传你的包到 PyPI。首先你需要安装 twine：

pip install twine  # 安装 twine

然后使用以下命令上传你的包：

twine upload dist/*  # 上传 dist 文件夹中的所有包

在上传之前，确保你已经在 PyPI 注册并且有账号。

可视化分析

文件结构饼状图

使用 mermaid 语法绘制的文件结构饼状图如下：

pie
    title 项目文件结构
    "my_module.py": 30
    "setup.py": 20
    "README.md": 25
    "LICENSE": 15

状态图

使用 mermaid 语法绘制的发布状态图如下：

stateDiagram
    [*] --> 创建项目
    创建项目 --> 编写代码
    编写代码 --> 创建 setup.py
    创建 setup.py --> 添加必要文件
    添加必要文件 --> 打包代码
    打包代码 --> 发布到 PyPI
    发布到 PyPI --> [*]