跳转至

发布您的插件

来源信息

假设您已完成新版本的所有工作,编写了发布说明,增加了版本号,标记了发布,并准备发布。

安装twine

如果您还没有这样做,您将需要安装TwineTwine是一个用于将Python包发布到PyPI和其他存储库的实用程序。

pip install twine

构建您的包

构建您的包就像一行命令一样简单。

pipx run build

这将在隔离的环境中构建包,在dist/目录中生成源分布和wheel。

上传到TestPyPI

与是所有python包的实际索引的PyPI不同,TestPyPI是Python Package Index的单独实例。这是在不影响真实索引的情况下尝试分发工具和流程的好地方。

由于TestPyPI与实时PyPI有单独的数据库,您需要专门为TestPyPI创建的单独用户帐户。前往https://test.pypi.org/account/register/来注册您的帐户。

完成后,您可以通过指定--repository/-r标志使用twine将分发上传到TestPyPI

twine upload -r testpypi dist/*

Twine将提示输入您的API令牌或用户名和密码。

!!! tip 出于安全原因,强烈建议在将包上传到PyPI创建API令牌而不是使用用户名和密码。如果您还没有这样做,请在PyPITestPyPI上创建一个API令牌。您还将被要求选择此令牌的范围,目前您可以将令牌保留为不受限制。

上传到PyPI

现在,如果一切看起来都对,您可以上传到实际的Python Package Index - PyPI

twine upload -r pypi dist/*

使用GitHub Actions CI/CD工作流发布

GitHub Actions CI/CD允许您在GitHub平台上发生事件时运行一系列命令。如果您想在每次创建发布时自动将您的插件发布到PyPI,这将是一个很好的选择。

有关更多信息,请按照说明进行操作。

就是这样!

🥳 恭喜! 如果一切顺利,您应该很快就能在https://pypi.org/project/<package name>上看到您的插件。