一、前置说明

1、总体目录

• 《 pyparamvalidate 参数校验器，从编码到发布全过程》

2、相关回顾

• 使用 schema 库，自定义较复杂的校验方法

3、本节目标

• 了解发布至 pypi 的基本流程。
• 将 pyparamvalidate 项目，发布至 pypi。

二、操作步骤

1、项目目录

• atme : @me 用于存放临时的代码片断或其它内容。
• pyparamvalidate : 新建一个与项目名称同名的package，为了方便发布至 pypi 。
• core : 用于存放核心代码。
• tests : 用于存放测试代码。
• utils : 用于存放一些工具类或方法。
• LICENSE : 描述许可证内容。
• pyproject.toml : 描述打包信息。
• README.md : 描述项目说明文档。

2、编写 pyproject.toml 文件

# 指定构建后端
[build-system]

# 指定构建所依赖的包，在构建时自动安装依赖包
requires = ["hatchling"]

# 指定构建后端为 hatchling.build
build-backend = "hatchling.build"

[project]
# 项目名称
name = "pyparamvalidate"

# 版本号
version = "0.3.2"

# 作者
authors = [
    { name = "kindtester", email = "kindtester@foxmail.com" },
]

# 项目描述
description = "一个简单易用的 Python 函数参数校验装饰器。提供多种内置验证器，支持自定义验证规则，帮助开发者轻松进行函数参数校验。"

# 说明文档: 该说明文档的内容将展示在 pypi 项目首页的 Project description, 此 README.md 就是同级目录下的 README.md 文档
readme = "README.md"

# python 版本要求
requires-python = ">=3.9"

# 分类器描述，用于说明包的元数据信息，以便开发者和用户能够更容易地了解该包的特性、兼容性和用途
# 下面是一个典型的分类器，描述了该项目适用于 Python 3，采用 MIT 许可证，且独立于操作系统
classifiers = [
    "Programming Language :: Python :: 3",
    "License :: OSI Approved :: MIT License",
    "Operating System :: OS Independent",
]

# 项目的依赖包：在 pip install pyparamvalidate 时，会自动安装这些依赖包
dependencies = [
    'pytest',
    'schema',
]


# 相关链接：指定之后可以在 pypi 项目首页的 Project links 显示该链接
[project.urls]
homepage = "https://github.com/xyouwen/pyparamvalidate"

# github 仓库：指定之后可以在 pypi 项目首页使用 GitHub statistics
[project.github]
repository = "https://github.com/xyouwen/pyparamvalidate"

# 指定要打包的目录
[tool.hatch.build.targets.wheel]

# 此处只打包 pyparamvalidate 及其所有子目录
packages = ["pyparamvalidate"]

3、编写 LICENSE 文件

此处使用 MIT 许可协议，它是一种宽松的、自由的许可协议，允许软件的自由使用、修改、分发和私有化。

MIT License

Copyright (c) 2024 kindtester

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

4、编写 README.md 文件

请参考 github 中的 README.md 文档，顺便帮忙点个小星星。

5、升级 pip、build、twine 工具

某些命令需要较新版本的工具，因此需要对工具进行升级：

pip install --upgrade pip
pip install --upgrade build
pip install --upgrade twine

6、打包发布的版本

python -m build

打包过程需要一定时间，打包完成后，在项目目录中会新增 dist 目录：

7、测试发布至 TestPyPI

在 TestPyPI 上，可以测试的 Python 软件包的发布和分发流程，而不会影响到真正的 PyPI 上的软件包。

1） 在 TestPyPI 上注册一个帐户： https://test.pypi.org/account/register/

2）完成 Two factor authentication (2FA) 验证

安装谷歌浏览器插件 身份验证器 ：
https://chrome.google.com/webstore/detail/authenticator/bhghoamapcdpbohphigoooaddinpkbai

安装后点击扫描，选中网页提供的二维码，插件会生成一个code，粘贴到网页需要输入code的地方。

3）生成 API token

复制这个 token:

4）上传至 testpypi

twine upload --repository testpypi dist/*

username: __token__
password：刚才复制的 token

8、创建测试项目，测试发布结果

点击上传至 test.pypi 之后的 View at 链接跳转：

复制 pip install 内容：

pip install -i https://test.pypi.org/simple/ pyparamvalidate==0.3.3

在测试项目中安装后测试功能是否正常：

在 Lib 目录下的 sitepackage 目录查看包是否正常：

9、正式发布至 PyPI

PyPI（Python Package Index）是Python的官方软件包索引，用于存储和分发 Python 软件包。

1）在 pypi 上注册一个账户： https://pypi.org
2）完成 Two factor authentication (2FA) 验证，过程与第 7 步 相同
3）生成 API token，过程与第 7 步 相同
4）上传至 pypi

twine upload dist/*

10、测试正式发布结果

测试过程与第 8 步骤相同。
测试通过后，发布完成。

三、后置说明

1、要点小结

• 发布至 pypi 时，注意项目结构的配置。
• 先发布至 testpypi 测试通过之后，再正式发布至 pypi。
• 在使用 twine upload 上传时，需要使用 API token 进行身份验证。
• 官方参考文档，请见：https://packaging.python.org/en/latest/tutorials/packaging-projects/#uploading-the-distribution-archives

2、下节准备

• 连载完。

点击返回主目录