PyPI 배포용 패키지에 설명을 추가해보자

PyPI 에서 내 패키지를 검색하면, Project description란이 있는데, 텅 비어있어서 보기가 좋지 않았다. 하지만, github에 올라간 repo에는 README.md가 바로 보여져서 project description이 잘 되어 있다.

이 README.md파일을 PyPI에서도 보여지게 만들어보는게 이 글에 목적이다.

setup.py 에 long_discription 추가

PyPI에 업데이트가 된다.

long_description_content_type=’text/markdown’,

저 항목을 추가하면 마크다운이 된다.

H1(# ) Mark Down이 적용된 모습

with open('README.md', encoding='utf-8') as f:
    long_description = f.read()

위 코드를 추가해서 README.md를 열어주고

long_description = long_description,
long_description_content_type='text/markdown',

위 코드를 setup.py안에 추가해주면 깃허브에서 보이는 README.md 와 똑같이 보인다.

README.md 파일에서 가져오기 (setup.py와 동일폴더에 있어야함)

README.md 파일에 있는 내용이 PyPI에 그대로 업로드가 된다.

Full code of setup.py

정리하면

README.md 파일을 PyPI project description 에서 나타나게 만들 수 있다.
setup.py안에 long_description를 포함시켜주고
long_description_content_type='text/markdown', 을추가해주면 마크다운도 추가된다