신뢰할 수 있는 게시 ‐ Python 패키지를 게시하는 것이 그 어느 때보다 쉬워졌습니다.-파이썬 튜토리얼-php.cn

집

백엔드 개발

파이썬 튜토리얼

신뢰할 수 있는 게시 ‐ Python 패키지를 게시하는 것이 그 어느 때보다 쉬워졌습니다.

Barbara Streisand

Dec 06, 2024 pm 06:04 PM

Python 패키지를 게시하는 것은 어려운 작업이었지만 더 이상은 아닙니다. 게다가 훨씬 더 안전해졌습니다. CLI 도구에 의존하면서 사용자 이름, 비밀번호 또는 API 토큰을 저글링하는 시대는 지났습니다. 신뢰할 수 있는 게시를 사용하면 PyPI에 GitHub 저장소의 세부 정보를 제공하기만 하면 GitHub Actions가 어려운 작업을 처리합니다.

신뢰할 수 있는 게시를 통해 Python 패키지를 게시하는 방법

태그가 생성될 때(개발 브랜치에서) TestPyPi에 패키지를 게시하거나 메인 브랜치에 병합할 때 PyPi에 패키지를 게시하는 워크플로를 소개하겠습니다.

게시를 위해 패키지 준비

Python 패키지가 PyPI의 패키징 지침을 따르는지 확인하세요. 최소한 다음이 필요합니다.

패키지 메타데이터를 정의하는 ~~setup.py 또는~~ pyproject.toml 파일
명확한 디렉토리 레이아웃과 올바르게 구조화된 코드.
PyPI에서 프로젝트를 소개하기 위한 README 파일입니다.

자세한 체크리스트는 Python 패키징 사용자 가이드를 참조하세요.

저장소에서 GitHub 작업 구성

새 GitHub 작업인 .github/workflows/test-build-publish.yml을 만들어 시작해 보겠습니다.

name: test-build-publish

on: [push, pull_request]

permissions:
  contents: read

jobs:

  build-and-check-package:
    name: Build & inspect our package.
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - uses: hynek/build-and-inspect-python-package@v2

로그인 후 복사

이 작업을 수행하면 패키지가 빌드되고 빌드된 휠과 소스 배포(SDist)가 GitHub Actions 아티팩트로 업로드됩니다.

다음으로 TestPyPI에 게시하는 단계를 추가합니다. 이 단계는 태그가 생성될 때마다 실행되어 이전 단계의 빌드가 성공적으로 완료되었는지 확인합니다. PROJECT_OWNER 및 PROJECT_NAME을 저장소에 적합한 값으로 바꾸십시오.

  test-publish:
    if: >-
        github.event_name == 'push' &&
        github.repository == 'PROJECT_OWNER/PROJECT_NAME' &&
        startsWith(github.ref, 'refs/tags')
    needs: build-and-check-package
    name: Test publish on TestPyPI
    runs-on: ubuntu-latest
    environment: test-release
    permissions:
      id-token: write
    steps:
      - name: Download packages built by build-and-check-package
        uses: actions/download-artifact@v4
        with:
          name: Packages
          path: dist

      - name: Upload package to Test PyPI
        uses: pypa/gh-action-pypi-publish@release/v1
        with:
          repository-url: https://test.pypi.org/legacy/

로그인 후 복사

이 단계에서는 빌드 프로세스 중에 생성된 아티팩트를 다운로드하고 테스트를 위해 TestPyPI에 업로드합니다.

마지막 단계에서는 풀 요청이 메인 브랜치에 병합되면 PyPI에 패키지를 업로드합니다.

  publish:
    if: >-
      github.event_name == 'push' &&
      github.repository == 'PROJECT_OWNER/PROJECT_NAME' &&
      github.ref == 'refs/heads/main'
    needs: build-and-check-package
    name: Publish to PyPI
    runs-on: ubuntu-latest
    environment: release
    permissions:
      id-token: write
    steps:
      - name: Download packages built by build-and-check-package
        uses: actions/download-artifact@v4
        with:
          name: Packages
          path: dist

      - name: Publish distribution ? to PyPI for push to main
        uses: pypa/gh-action-pypi-publish@release/v1

로그인 후 복사