在Python中，我们经常从PyPI通过pip cmd安装各种第三方库，那么如何从头构建一个标准的python库呢？那么，让我们找出来。

项目打包

我们需要定义一个标准的Python项目结构，然后按照下面的步骤一步步开始打包。[1]

项目结构

首先创建一个要发布的代码文件夹，组织项目结构并添加一些必要的文件，例如项目名称、许可证、README.md、setup.py 等。[2]

包装
├── MY_PROJECT 
│├──模块1 
││├──__ init__的.py 
││└──打招呼的.py 
│├──模块2 
││├──__ init__的.py 
││└──再见的.py 
│ ├── __ init__ .py 
│ └── utils .py 
├── LICENSE 
├── README .md 
└── setup .py   #也 setup .cfg

示例工程很简单，都是空文件，其他文件如下：

• 你好.py

def  hello_world () :
    打印( “你好世界！” )

• 再见.py

def  goodbye () :
    打印（ “再见！”）

• 实用程序.py

def  test () : 
    print( “一个用于包装的演示项目。” )

添加许可证

PyPI 要求所有上传的包必须包含许可证，利用[3]帮助选择许可证，然后将许可证内容复制到文件 LICENSE.

请注意，某些许可证需要年份 ([year]) 和所有者（[fullname] 或 [name of copyright owner]）

例如，麻省理工学院执照：

麻省理工学院执照

版权所有 (c) [2022] [my_project]

特此向任何获得副本的人免费授予许可
本软件和相关文档文件（“软件”），以处理
在软件中不受限制，包括但不限于权利
以使用，复制，修改，合并，发布，分发，再许可和/或销售
复制的软件，并 以许可人到人的软件是
提供给 做的话，受到了以下条件：

以上版权声明 和本许可声明应包含在所有
副本或实质部分的软件。

本软件IS提供的“原样”，无担保的 任何形式的明示或
暗示，INCLUDING BUT NOT LIMITED TO THE担保的适销性，
FITNESS FOR特定用途的适用性和不侵权。IN  NO  EVENT应在
作者 或版权所有者均不FOR 任何索赔，损害或其他
责任，无论是在AN行动 的合同，侵权或其他原因，FROM，
 OUT  OF 或 IN 连接 与本软件或的使用 或其他交易IN THE
软件。

添加说明

根据markdown语法写出项目的详细描述，然后可以作为setup.py中的入口「long_description」

# 示例包
这是一个简单的示例包。您可以使用 [ Github-flavored Markdown ]( https://guides.github.com/features/mastering-markdown/ ) 来编写您的内容。

配置设置元数据

有两种类型的设置元数据类型：

• 静态设置元数据
• 动态设置元数据

对于静态元数据 setup.cfg 或 setup.py 首选官方推荐。

静态设置元数据

以下是官方示例 setup.cfg。

[元数据]
name = example-pkg-YOUR-USERNAME-HERE
版本 = 0.0.1
作者 = 示例作者
author_email = author@example.com
description = 一个小示例包
long_description = 文件：README.md
long_description_content_type = 文本/降价
网址 = https://github.com/pypa/sampleproject
project_urls =
    错误跟踪器 = https://github.com/pypa/sampleproject/issues
分类器 =
    编程语言 :: Python :: 3
    许可证 :: OSI 批准 :: MIT 许可证
    操作系统 :: 独立于操作系统

[选项]
包目录 = src
包 = 查找：
python_requires = >=3.6

[options.packages.find]
其中 = src

动态设置元数据

官方的例子，可以看出，本质上是一样的，也可以用现成的模板setup.py写成[4]

导入设置工具

使用 open( "README.md" , "r" , encoding = "utf-8" )作为fh：
    long_description = fh.read()

setuptools.setup(
    name= "example-pkg-YOUR-USERNAME-HERE" ,
    version= "0.0.1" ,
    author= "示例作者" ,
    author_email= "author@example.com" ,
    description= "一个小示例包" ,
    long_description=long_description，
    long_description_content_type= "文本/降价" ,
    url= "https://github.com/pypa/sampleproject" ,
    项目网址={
        "Bug Tracker" : "https://github.com/pypa/sampleproject/issues" ,
    },
    分类器=[
        “编程语言 :: Python :: 3”、
         “许可证 :: OSI 批准 :: MIT 许可证”、
         “操作系统 :: OS 独立”、
    ],
    package_dir={ "" : "src" },
    包=setuptools.find_packages( where = "src" ),
    python_requires= ">=3.6" ,
)

其实可以理解为一个ini文件，里面包含了命令的默认选项和setup.cfg或者setup.py

准备 venv

我们还有 Win10 WSL-2 中的 Ubuntu 20.04 Server (Python 3.8.10)，创建和使用虚拟环境「venv」

# 安装 venv 
sudo apt install python3-venv -y

# 创建 venv
目录代码
python -m venv /home/xxx/code

＃ 启用
源/home/xxx/code/bin/activate

构建包

使用以下配置文件 setup.py

导入设置工具

使用open ( "README.md" , "r" , encoding= "utf-8" )作为fh:
    long_description = fh。读()

setuptools.setup(
    名称= “my_project”，
    版本= “0.0.1”，
    作者 = "xxx" ,
    author_email= "xxxxx@xxx.com" ,
    description= "一个小示例包" ,
    long_description=long_description，
    long_description_content_type= "文本/降价" ,
    url= "https://github.com/xxxx" ,
    分类器=[
        “编程语言 :: Python :: 3”、
         “许可证 :: OSI 批准 :: MIT 许可证”、
         “操作系统 :: OS 独立”、
    ],
    包=setuptools.find_packages(),
    python_requires= ">=3.6" ,
)

安装支持从源代码构建包的 setuptools 和 wheel。[5]

pip安装安装工具
pip安装轮

进入打包文件夹，查看setup.py，如果有错误会打印提示信息。

# 运行检查
python setup.py 检查

打包成.tar.gz或wheel，自动创建目录，对应文件sdist。[6]

# 构建到.tar.gz
 python设置。py sdist 构建

#或构建到轮
python设置。py sdist bdist_wheel

PyPI 已发布

至此，我们已经完成了项目的打包。接下来，我们需要将打包模块发布到 pypi 或我们自己的私有服务器。

官方 PyPI 服务器

当我们使用官方PyPI服务器时，我们需要先在[7]中注册一个账号

然后安装twine上传包。

pip安装麻线

接下来输入帐户信息并完成上传。

麻线上传 dist/*

本地 PyPI 服务器

安装并创建一个文件夹来放置发布的包 pypiserver 包。[8]

pip安装 pypiserver
mkdir ~/packages

上传到目录，mv直接在同一个虚拟机my_project-0.0.1.tar.gz上操作到~/packages。

mv dist/my_project- 0。0 . 1 .tar.gz ~/packages

运行服务器，端口指定为8080，默认监听8080的所有ip地址。

pypi- server -p 8080 ~/packages &

测试

在本地服务器 my_project 或 PyPI 上搜索包

# 官方服务器
pip搜索my_project

#本地服务器
pip 搜索 --index http://localhost:8080 my_project

安装并使用 my_project 包。

# 从官方服务器
安装pip install my_project

# 从本地服务器安装
pip install --extra-index-url http://localhost:8080 my_project