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

(시리즈 글이 4개 있습니다.)
개발 환경 구성: 610. 파이썬 - PyPI 패키지 만들기
; https://www.sysnet.pe.kr/2/0/12863

개발 환경 구성: 611. 파이썬 - PyPI 패키지 만들기 (2) long_description, cmdclass 옵션
; https://www.sysnet.pe.kr/2/0/12865

개발 환경 구성: 612. 파이썬 - PyPI 패키지 만들기 (3) entry_points 옵션
; https://www.sysnet.pe.kr/2/0/12867

개발 환경 구성: 614. 파이썬 - PyPI 패키지 만들기 (4) package_data 옵션
; https://www.sysnet.pe.kr/2/0/12870




파이썬 - 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

비밀번호

댓글 작성자
 




... 136  137  138  139  140  141  142  143  144  145  146  147  [148]  149  150  ...
NoWriterDateCnt.TitleFile(s)
1402정성태1/14/201334694오류 유형: 166. SmtpClient.Send 오류 - net_io_connectionclosed
1401정성태1/11/201332174.NET Framework: 356. (공개키를 담은) 자바의 key 파일을 닷넷의 RSACryptoServiceProvider에서 사용하는 방법 [2]파일 다운로드1
1400정성태1/10/201331357Windows: 69. 작업표시줄의 터치 키보드(Touch Keyboard) 없애는 방법 [3]
1399정성태1/9/201326925.NET Framework: 355. 닷넷 환경이 왜 C/C++보다 느릴까요? [8]
1398정성태1/8/201327222오류 유형: 165. 새로 설치한 Visual Studio 2010의 Team Explorer 실행시 비정상 종료가 된다면?
1397정성태1/3/201330827Windows: 68. 윈도우 설치 ISO 이미지를 USB 하드에 적용하는 방법 [2]
1396정성태12/27/201232232사물인터넷: 2. 넷두이노 - 4.2.0 펌웨어 업데이트 방법 [1]파일 다운로드1
1395정성태12/26/201222697.NET Framework: 354. x64 - AspCompat과 STA COM 개체가 성능에 미치는 영향
1394정성태12/25/201223886.NET Framework: 353. x86 - AspCompat과 STA COM 개체가 성능에 미치는 영향
1393정성태12/25/201225092.NET Framework: 352. x64에서 필수로 지정하도록 바뀐 STAThread 특성 [2]
1392정성태12/21/201235008사물인터넷: 1. .NET Micro Framework - 넷두이노 플러스 [7]
1391정성태12/21/201227599.NET Framework: 351. JavaScriptSerializer, DataContractJsonSerializer, Json.NET [3]파일 다운로드1
1390정성태12/20/201225959.NET Framework: 350. String 데이터를 Stream으로 변환하는 방법 [2]
1389정성태12/12/201223981.NET Framework: 349. .NET Thread 인스턴스로부터 COM Apartment 유형 확인하는 방법파일 다운로드1
1388정성태12/12/201225099.NET Framework: 348. .NET x64 응용 프로그램에서 Teb 주소를 구하는 방법파일 다운로드1
1387정성태12/12/201230433VC++: 64. x64 Visual C++에서 TEB 주소 구하는 방법
1386정성태12/12/201231462디버깅 기술: 53. windbg - 덤프 파일로부터 네이티브 DLL을 추출하는 방법 [1]
1385정성태12/12/201227066디버깅 기술: 52. Windbg - The version of SOS does not match the version of CLR you are debugging.
1384정성태12/12/201231656개발 환경 구성: 178. System32 폴더의 64비트 DLL을 32비트 Depends.exe에서 보는 방법
1383정성태12/10/201227791개발 환경 구성: 177. 기업용 메신저를 위한 Office Communicator Server 2007 설치 [1]
1382정성태12/8/201230275개발 환경 구성: 176. WebPagetest 서버 - 설치 및 테스트
1381정성태12/5/201229242.NET Framework: 347. C# - 프로세스(EXE) 수준의 Singleton 개체 생성 [2]파일 다운로드1
1380정성태11/28/201239329.NET Framework: 346. 닷넷 개발자에게 Node.js의 의미 [17]
1379정성태11/26/201232710.NET Framework: 345. C# 부호(+, -)에 대한 비트 변환 [1]
1378정성태11/22/201233594Java: 14. 안드로이드 - Hello World 실습 [7]
1377정성태11/19/201227371.NET Framework: 344. 닷넷 프로파일러 - ICorProfilerInfo::GetILFunctionBody 함수 버그
... 136  137  138  139  140  141  142  143  144  145  146  147  [148]  149  150  ...