如何利用GitHubAction来发布自己的Python软件包

我们开发的python软件包如果想发布到网上，可以让其他人通过pip install下载，一般是把软件包发布到PYPI平台。

PYPI准备

我们要现在pypi注册登录一下

文件组织架构

一般的python软件包的文件组织架构为包名文件夹+__init__.py+程序，包文件夹的同级有setup.py

.
│  LICENSE
│  README.md
│  setup.py
│
├─.github
│  └─workflows
│          publish-to-pypi.yml
│
└─package_name
        project.py
        __init__.py

这里我们要额外加一个.gituhb/workflows的文件夹，存储Action配置文件

配置Action

atcion文件示例如下

name: Publish Python 🐍 distributions 📦 to PyPI

on:
  release:
    types: [published]  # This will trigger the workflow only when a new release is published

jobs:
  build-n-publish:
    name: Build and publish Python 🐍 distributions 📦 to PyPI
    runs-on: ubuntu-22.04

    steps:
    - uses: actions/checkout@v2

    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: '3.10'

    - name: Install pypa/build
      run: python -m pip install build

    - name: Build a binary wheel and a source tarball
      run: python -m build --sdist --wheel . --outdir dist/

    - name: Install twine
      run: python -m pip install twine

    - name: Publish distribution to PyPI
      env:
        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
      run: twine upload dist/*

这里定义了在虚拟环境中的操作，打包然后利用twine发布包到pypi。

注意这里需要在仓库中配置secret：Settiing -> Secrets and vairables -> Action -> Repository secrets -> New 然后点击新建两个变量，分别取名PYPI_USERNAME和PYPI_PASSWORD，其中的value分别对应我们的pypi用户名和密码。

如果账户配置了双重认证，就得去pypi申请一个API：在pypi官网点击自己的用户名，选择Account settings，拉到最下面申请API

不能用用户名和密码登录了相应的代码也要一些修改

      env:
        TWINE_USERNAME: __token__
        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}

pypi中还需要配置一个信任的来源，填写你的仓库和包的信息

Action我们设置的是在仓库发布relase之后触发，所以我们需要先提交一个release

发布release之后action就会自动触发然后推送我们的包到pypi了