Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일
 

파이썬 - PyPI 패키지 만들기 (2) long_description, cmdclass 옵션

지난 글에 이어,

파이썬 - PyPI 패키지 만들기
; https://www.sysnet.pe.kr/2/0/12863

약간의 옵션을 좀 더 정리해보겠습니다.

우선, 이전의 setup.py로는,

from setuptools import setup, find_packages
import netutil


setup(
    name="net-util",
    description="utility functions for networking",
    version=netutil.__version__,
    author=netutil.__author__,
    author_email="techsharer@outlook.com",
    url="https://www.sysnet.pe.kr",
    license="Ms-PL",
    packages=find_packages(exclude=[]),
    install_requires=["requests>=2.22.0"],"
)

PyPI에 올렸을 때 소개가 이렇게 비어 있습니다.

pypi_adv_1.png

이 부분을 채우려면, long_description 속성을 채우면 되는데요, 재미있게도 어차피 setup.py가 파이썬 스크립트 파일이기 때문에 함수를 이용해 처리하는 것도 가능합니다.

...[생략]...

def readme():
    with open('README.md', 'rb') as f:
        return f.read().decode('utf-8')


setup(
    name="net-util",
    description="utility functions for networking",
    long_description=readme(),
    long_description_content_type='text/markdown',
...[생략]...
    install_requires=["requests>=2.22.0"],
)

또한, 해당 텍스트는 text/plain, text/x-rst, text/markdown 형식을 지원하므로 원하는 것을 선택해 파일로 만들어 두면 됩니다. 그래서 대충 이렇게 README.md를 만들어 두면,

# net-util

패키지 테스트를 위해 만든 예제 프로젝트입니다.

```python

 >>> import netutil
 >>> print(netutil.iputil.get_public_ip())
220.127.177.110
```

## Installing net-util and Supported Versions

net-util is available on PyPI:

```console
$ python -m pip install netutil
```

https://pypi.org/project/net-util/에서 그 결과를 확인할 수 있습니다. ^^




setup.py에서 좀 특별한 옵션이라면 바로 기존 패키징 코드를 사용자 정의할 수 있는 cmdclass 옵션입니다. 이 옵션을 활용하면 "python setup.py [cmd]"에 해당하는 명령어의 "[cmd]" 작업을 사용자 정의할 수 있습니다. 가령 [cmd]로 bdist_wheel을 사용하는 경우라면, 다음과 같이 bdist_wheel 작업을 확장할 수 있습니다.

import netutil
from wheel.bdist_wheel import bdist_wheel as _bdist_wheel
from setuptools import setup, find_packages


class UserCode(_bdist_wheel):
    def run(self):
        print('pre-process ===============================================')
        _bdist_wheel.run(self)
        print('post-process ==============================================')


setup(
    name="net-util",
    description="utility functions for networking",
    long_description=readme(),
    long_description_content_type='text/markdown',
    cmdclass={'bdist_wheel': UserCode},
    ...[생략]...
)

그럼 실행 시 다음과 같은 결과를 확인할 수 있습니다.

C:\temp> python setup.py bdist_wheel
running bdist_wheel
pre-process ===============================================
running build
running build_py
installing to build\bdist.win-amd64\wheel
running install
running install_lib
creating build\bdist.win-amd64\wheel
creating build\bdist.win-amd64\wheel\netutil
...[생략]...
adding 'netutil/network_logger.py'
adding 'net_util-1.0.0.2.dist-info/METADATA'
adding 'net_util-1.0.0.2.dist-info/WHEEL'
adding 'net_util-1.0.0.2.dist-info/top_level.txt'
adding 'net_util-1.0.0.2.dist-info/RECORD'
removing build\bdist.win-amd64\wheel
post-process ==============================================

위의 경우 단순히 pre/post 처리를 했지만 고급스럽게는 해당 [cmd] 작업의 내부 단계들을 가로채서 사용자 정의하는 것도 가능합니다.

사실 저런 식의 pre/post 작업이라면 그냥 단순하게 setup(...) 호출의 앞/뒤로 코드를 수행해도 유사한 결과를 얻습니다. (혹은, 아예 빌드 스크립트 차원에서 "python setup.py ..." 호출 전/후에 처리해도 되고.)

print('pre-process ===============================================')
setup(
    name="net-util",
    description="utility functions for networking",
    long_description=readme(),
    long_description_content_type='text/markdown',
    # cmdclass={'bdist_wheel': UserCode},
    ...[생략]...
)
print('post-process ==============================================')

참고로, cmdclass는 결국 "[cmd]"에 따라 달라지기 때문에 배포 패키징 명령어가 바뀐다면 그에 맞게 조정해야 합니다. 예를 들어 "python setup.py sdist"로 하는 경우라면 아래와 같이 코드가 바뀌게 됩니다.

from distutils.command.sdist import sdist as _sdist


class UserCode(_sdist):
    def run(self):
        _sdist.run(self)

setup(
    name="net-util",
    description="utility functions for networking",
    long_description=readme(),
    long_description_content_type='text/markdown',
    cmdclass={'sdist': UserCode},
    ...[생략]...
)




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[연관 글]






[최초 등록일: ]
[최종 수정일: 12/6/2021]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 




1  2  3  4  5  6  7  8  9  [10]  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
12894정성태12/30/20211289.NET Framework: 1125. C# - DefaultObjectPool<T>의 IDisposable 개체에 대한 풀링 문제 [3]파일 다운로드1
12893정성태12/27/20211538.NET Framework: 1124. C# - .NET Platform Extension의 ObjectPool<T> 사용법 소개파일 다운로드1
12892정성태12/26/20211110기타: 83. unsigned 형의 이전 값이 최댓값을 넘어 0을 지난 경우, 값의 차이를 계산하는 방법
12891정성태12/23/20211000스크립트: 38. 파이썬 - uwsgi의 --master 옵션
12890정성태12/23/20211090VC++: 152. Golang - (문자가 아닌) 바이트 위치를 반환하는 strings.IndexRune 함수
12889정성태12/22/20211604.NET Framework: 1123. C# - (SharpDX + DXGI) 화면 캡처한 이미지를 빠르게 JPG로 변환하는 방법파일 다운로드1
12888정성태12/21/20211373.NET Framework: 1122. C# - ImageCodecInfo 사용 시 System.Drawing.Image와 System.Drawing.Bitmap에 따른 Save 성능 차이파일 다운로드1
12887정성태12/21/20211509오류 유형: 777. OpenCVSharp4를 사용한 프로그램 실행 시 "The type initializer for 'OpenCvSharp.Internal.NativeMethods' threw an exception." 예외 발생
12886정성태12/20/20211185스크립트: 37. 파이썬 - uwsgi의 --enable-threads 옵션
12885정성태12/20/2021959오류 유형: 776. uwsgi-plugin-python3 환경에서 MySQLdb 사용 환경
12884정성태12/20/2021975개발 환경 구성: 620. Windows 10+에서 WMI root/Microsoft/Windows/WindowsUpdate 네임스페이스 제거
12883정성태12/19/20211273오류 유형: 775. uwsgi-plugin-python3 환경에서 "ModuleNotFoundError: No module named 'django'" 오류 발생
12882정성태12/18/20211012개발 환경 구성: 619. Windows Server에서 WSL을 위한 리눅스 배포본을 설치하는 방법
12881정성태12/17/20211249개발 환경 구성: 618. WSL Ubuntu 20.04에서 파이썬을 위한 uwsgi 설치 방법 (2)
12880정성태12/16/20211031VS.NET IDE: 170. Visual Studio에서 .NET Core/5+ 역어셈블 소스코드 확인하는 방법
12879정성태12/16/20214366오류 유형: 774. Windows Server 2022 + docker desktop 설치 시 WSL 2로 선택한 경우 "Failed to deploy distro docker-desktop to ..." 오류 발생
12878정성태12/15/20211203개발 환경 구성: 617. 윈도우 WSL 환경에서 같은 종류의 리눅스를 다중으로 설치하는 방법
12877정성태12/15/20211002스크립트: 36. 파이썬 - pymysql 기본 예제 코드
12876정성태12/14/20211040개발 환경 구성: 616. Custom Sources를 이용한 Azure Monitor Metric 만들기
12875정성태12/13/20211057스크립트: 35. python - time.sleep(...) 호출 시 hang이 걸리는 듯한 문제
12874정성태12/13/2021869오류 유형: 773. shell script 실행 시 "$'\r': command not found" 오류
12873정성태12/12/20211301오류 유형: 772. 리눅스 - PATH에 등록했는데도 "command not found"가 나온다면?
12872정성태12/12/20211090개발 환경 구성: 615. GoLang과 Python 빌드가 모두 가능한 docker 이미지 만들기
12871정성태12/12/20212025오류 유형: 771. docker: Error response from daemon: OCI runtime create failed
12870정성태12/9/2021992개발 환경 구성: 614. 파이썬 - PyPI 패키지 만들기 (4) package_data 옵션
12869정성태12/8/20211203개발 환경 구성: 613. git clone 실행 시 fingerprint 묻는 단계를 생략하는 방법
1  2  3  4  5  6  7  8  9  [10]  11  12  13  14  15  ...