<div id="readability-page-1" class="page"><article><div><a href="https://github.com/NovemberOscar/Sanic-JWT-Extended" target="_blank" rel="noreferrer">Sanic-JWT-Extended</a>를 만들며 처음으로 Poetry와 GitHub Action을 도입해 보았고 굉장히 감동받아 Poetry와 GitHub Action을 소개해 보려고 합니다.<h2 id="왜-poetry를-쓰나요">왜 Poetry를 쓰나요?</h2>Poetry는 Javascript의 npm과 yarn 처럼 의존성과 패키지 관리를 동시에 수행합니다. Poetry는 필요한 패키지 간의 의존성을 자동으로 풀어내고, 의존성 트리를 lock 파일에 저장함으로써 의존성이 꼬이는 문제를 막아줍니다. 물론 여기까지는 Pipenv도 충분히 할 수 있습니다. 하지만 Poetry는 의존성-패키지 관리자의 역할 뿐만 아니라 나아가 기존에는 setuptools의 영역이던 프로젝트를 관리할 수 있는 기능을 포함하고 있습니다.<blockquote>Poetry is a tool for dependency management and packaging in Python. </blockquote>기존에는 setuptools를 사용해 프로젝트를 관리하고, dependency resolving이 필요하다면 Pipenv를 사용하고, 만든 프로젝트를 pypi에 올리기 위해선 twine이란 도구를 써야 하는 등 하나의 파이썬 프로젝트를 괸리하기 위해 서로 설정을 공유할 수 없는 여러가지 툴들을 사용해야 했습니다.하지만 Poetry는 <code>pyproject.toml</code>이란 파일을 통해 의존성, 패키지, 그리고 프로젝트를 한곳에서 관리합니다. 이 파일을 통해 프로젝트를 정의했다면 이제는 간단히 <code>poetry install</code> 이란 명령어를 사용해 패키지를 설치할 수 있고 <code>poetry build</code>란 명령어를 사용해 wheel과 sdist를 모두 만들어 낼 수 있으며 <code>poetry publish</code>란 명령어를 통해 pypi든 사설 패키지 저장소든 상관없이 업로드할 수 있습니다. 그리고 이 모든 것을 위해선 단지 Poetry 하나만 설치하면 됩니다.<div><pre>1[tool.poetry]2name = "Sanic-JWT-Extended"3version = "1.0-dev.9"4description = "Extended JWT integration with Sanic"5authors = [6 "Seonghyeon Kim &lt;kim@seonghyeon.dev&gt;"7]8license = "MIT"9readme = "README.md"10repository = "https://github.com/NovemberOscar/Sanic-JWT-Extended"11documentation = "https://sanic-jwt-extended.seonghyeon.dev/"12keywords = ["sanic", "jwt", "json web token"]13classifiers=[...]1415[tool.poetry.dependencies]16# 생략1718[tool.poetry.dev-dependencies]19# 생략2021[build-system]22requires = ["poetry&gt;=0.12"]23build-backend = "poetry.masonry.api"</pre></div><h2 id="왜-github-action을-쓰나요">왜 GitHub Action을 쓰나요?</h2>기존에는 CI를 사용하려면 Circle CI, Travis CI 등등의 외부 서비스를 사용해서 테스트와 코드 체크를 수행했습니다. 하지만 GitHub Action이 출시되었고. 외부 서비스에게 전쟁을 선포했습니다.<img src="https://seonghyeon.dev/5b31515a7b5a4a653852c191fc72b2fe/war-were-declared.gif">당연하게도 기존에 다른 서비스들이 제공하던 것처럼 PR과 push에 연결되어 테스트를 수행할 수 있습니다.추가적으로 여러가지의 환경에서 테스트를 돌릴 수도 있으며, 단계를 구분할 수도 있고, 다른사람들이 만든 액션을 가져다가 사용할 수도 있습니다<img src="https://seonghyeon.dev/static/eb4cfc847ff8e204db4e0e60ce4a39c4/9b5c6/test-action.png" alt="test action">
 
 아래의 GitHub Action workflow은 다음의 내용들을 수행합니다.<ul><li>파이썬 3.6과 3.7 환경에서 테스트를 수행</li><li>poetry를 설치하고 설치된 poetry를 사용해 패키지 설치</li><li>테스트를 수행하고 커버리지 추출</li><li>만들어진 커버리지 리포트를 codecov에 업로드</li></ul><div><pre>1name: Tests23on: [push, pull_request]45jobs:6 build:7 runs-on: ubuntu-latest8 strategy:9 max-parallel: 410 matrix:11 python-version: [3.6, 3.7]1213 steps:14 - uses: actions/checkout@v115 - name: Set up Python ${{ matrix.python-version }}16 uses: actions/setup-python@v117 with:18 python-version: ${{ matrix.python-version }}19 - name: Install Poetry20 run: |21 curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python22 source $HOME/.poetry/env23 - name: Install dependencies24 run: |25 source $HOME/.poetry/env26 poetry install27 - name: Test28 run: |29 source $HOME/.poetry/env30 poetry run pytest --cov=sanic_jwt_extended tests/ --cov-report=xml31 - name: Upload coverage to Codecov 32 uses: codecov/codecov-action@v133 with: 34 token: ${{ secrets.CODECOV_TOKEN }}35 file: ./coverage.xml36 flags: unittests</pre></div>추가적으로 GitHub 내부 서비스 답게 GitHub Action은 repository 내부에서 일어나는 활동에 트리거되어 동작할 수 있습니다. 액션을 트리거할 수 있는 이벤트는 많지만 그중에서 특히 유용한 이벤트는 릴리즈 이벤트입니다. 깃허브의 릴리즈 기능을 사용하면 자동으로 실행되어 PyPI에 패키지를 빌드해 업로드하는 액션을 만들 수도 있습니다.<img src="https://seonghyeon.dev/static/b1fe8ed4ae0f1ca4cda4aac8676f4503/9b5c6/publish-action.png" alt="publish action">
 
 아래의 GitHub Action workflow은 다음의 내용들을 수행합니다.<ul><li>릴리즈가 생성될 때 동작</li><li>poetry를 설치하고 패키지 설치</li><li>GitHub secret에 저장된 값을 사용해 pypi 계정 정보를 세팅</li><li>PyPI에 패키지를 빌드한 후 업로드</li></ul><div><pre>1name: Upload to PyPI23on:4 release:5 types: [created]67jobs:8 deploy:9 runs-on: ubuntu-latest1011 steps:12 - uses: actions/checkout@v113 - name: Set up Python 3.714 uses: actions/setup-python@v115 with:16 python-version: '3.7'17 - name: Install Poetry18 run: |19 curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python20 source $HOME/.poetry/env21 - name: Install dependencies22 run: |23 source $HOME/.poetry/env24 poetry install25 - name: Build and publish26 run: |27 source $HOME/.poetry/env28 poetry config http-basic.pypi ${{ secrets.PYPI_USERNAME }} ${{ secrets.PYPI_PASSWORD }}29 poetry publish --build</pre></div><h2 id="그래서-우리가-뭘-한거죠">그래서 우리가 뭘 한거죠?</h2><ul><li>setuptools, twine, pipenv를 마음속에 묻고 poetry와 새출발<ul><li>관리 포인트가 줄고 CI 과정도 단순해짐</li><li>다만 GitHub가 pyproject.toml 형식을 인식 못해서 내 패키지를 누가 쓰는가와 내가 뭘 쓰는지 알려주는 기능을 사용할 수 없음</li></ul></li><li>Travis CI등 외부 CI를 걷어내고 GitHub Action 도입<ul><li>자동으로 PR과 push에 반응해 테스트 수행</li></ul></li><li>자동화!<ul><li>릴리즈를 만들면 자동으로 해당하는 릴리즈를 빌드해 pypi에 업로드</li></ul></li></ul></div></article></div>

seonghyeon.dev

Seonghyeon Kim

Poetry와 GitHub Action을 사용하여 파이썬 패키지를 관리하는 법에 대하여 알아봅시다.

GitHub Action과 Poetry를 사용한 파이썬 패키지 개발

댓글