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

비밀번호

댓글 작성자
 




... 121  122  123  124  125  126  127  128  [129]  130  131  132  133  134  135  ...
NoWriterDateCnt.TitleFile(s)
2872정성태2/25/201523274디버깅 기술: 70. windbg + 닷넷 디버깅 (1) - 배열 인덱스 사용 패턴
2871정성태2/24/201527046개발 환경 구성: 258. 윈도우 8.1에서 방화벽과 함께 FTP 서버 여는 (하지만, 권장하지 않는) 방법 [1]
2870정성태2/24/201528383개발 환경 구성: 257. 윈도우 8.1에서 방화벽과 함께 FTP 서버 여는 방법
2869정성태2/23/201522019.NET Framework: 500. struct로 정의한 값 형식(Value Type)의 경우 Equals 재정의를 권장합니다.파일 다운로드1
2868정성태2/23/201526809VS.NET IDE: 97. Visual C++ 프로젝트 디버깅 시에 Step-Into(F11) 동작이 원치 않는 함수로 진입하는 것을 막는 방법 [2]
2867정성태2/23/201520446오류 유형: 273. File History - Failed to initiate user data backup (error 80070005)
2866정성태2/23/201522341오류 유형: 272. WAT080 : Failed to locate the Windows Azure SDK. Please make sure the Windows Azure SDK v2.1 is installed.
1868정성태2/20/201519162오류 유형: 271. The type '...' cannot be used as type parameter 'TContext' in the generic type or method 'System.ServiceModel.DomainServices.EntityFramework.LinqToEntitiesDomainService<T>
1866정성태2/20/201520385오류 유형: 270. "aspnet_regiis -i" 실행 시 0x00000006 오류 해결 방법
1865정성태2/20/201521809.NET Framework: 499. 특정 닷넷 프레임워크 버전 이후부터 제공되는 타입을 사용해야 한다면?
1864정성태2/18/201526673.NET Framework: 498. C#으로 간단하게 만들어 본 ASCII Art 프로그램 [2]파일 다운로드1
1862정성태2/18/201530804.NET Framework: 497. .NET Garbage Collection에 대한 정리 [6]
1861정성태2/18/201525822.NET Framework: 496. 마우스 커서가 놓인 지점의 문자열 얻는 방법 [1]파일 다운로드1
1860정성태2/18/201525823.NET Framework: 495. CorElementType의 요소 값 설명파일 다운로드1
1859정성태2/17/201526299Windows: 106. 컴퓨터를 재부팅하면 절전(Power Saver) 전원 모드로 돌아가는 경우
1858정성태2/16/201536194Windows: 105. 자동으로 로그아웃/잠김 화면 상태로 전환된다면? [2]
1857정성태2/16/201524246.NET Framework: 494. 값(struct) 형식의 제네릭(Generic) 타입이 박싱되는 경우의 메타데이터 토큰 값파일 다운로드1
1856정성태2/15/201522991.NET Framework: 493. TypeRef 메타테이블에 등록되는 타입의 조건파일 다운로드1
1855정성태2/10/201522362개발 환경 구성: 256. WebDAV Redirector - Sysinternals 폴더 연결 시 "The network path was not found" 오류 해결 방법
1854정성태2/10/201523291Windows: 104. 폴더는 삭제할 수 없지만, 그 하위 폴더/파일은 생성/삭제/변경하는 보안 설정
1853정성태2/6/201553871웹: 29. 여신금융협회 웹 사이트의 "Netscape 6.0은 지원하지 않습니다." 오류 메시지 [5]
1852정성태2/5/201524552.NET Framework: 492. .NET CLR Memory 성능 카운터의 의미파일 다운로드1
1851정성태2/5/201525101VC++: 88. 하룻밤의 꿈 - 인텔 하스웰의 TSX Instruction 지원 [2]
1850정성태2/4/201546116Windows: 103. 작업 관리자에서의 "Commit size"가 가리키는 메모리의 의미 [4]
1849정성태2/4/201525410기타: 51. DropBox의 CPU 100% 현상 [1]파일 다운로드1
1848정성태2/4/201521179.NET Framework: 491. 닷넷 Generic 타입의 메타 데이터 토큰 값 알아내는 방법 [2]
... 121  122  123  124  125  126  127  128  [129]  130  131  132  133  134  135  ...