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

비밀번호

댓글 작성자
 




... 151  152  153  154  [155]  156  157  158  159  160  161  162  163  164  165  ...
NoWriterDateCnt.TitleFile(s)
1268정성태3/27/201237021오류 유형: 148. WCF svc 호출 시 HTTP Error 404.17 - Not Found [1]
1267정성태3/16/201235678.NET Framework: 314. C++의 inline asm 사용을 .NET으로 포팅하는 방법 [1]파일 다운로드1
1266정성태3/14/201238388개발 환경 구성: 149. RAID 1 구성 시 하드 디스크 장애 발생 해결에 대한 경험담
1265정성태3/13/201228713VC++: 61. 아이태니엄(IA64: Itanium) 에서 겪은 C++ 포인터 연산 문제 [2]
1264정성태3/10/201248514.NET Framework: 313. WELL512 난수 발생 알고리즘 - C# [5]파일 다운로드1
1263정성태3/9/201226809개발 환경 구성: 148. tinyget 사용법
1262정성태3/8/201247556개발 환경 구성: 147. .keystore 파일에 저장된 개인키 추출 방법과 인증기관으로부터 온 공개키를 합친 pfx 파일 만드는 방법 [1]
1261정성태3/7/201227848Phone: 2. 개발자용 윈도우 폰 7 기기 등록하는 방법
1260정성태3/6/201228434Phone: 1. 윈도폰 7 개발자 (회사) 등록하는 방법 [3]
1259정성태3/4/201239894Windows: 57. 새로 추가된 네트워크 커널 디버깅 및 PowerShell 3.0 [1]
1258정성태3/3/201241377개발 환경 구성: 146. SQL Server 2012에 포함된 LocalDB 기능 소개 [3]파일 다운로드1
1257정성태3/3/201229980.NET Framework: 312. Native 스레드와 Managed 스레드 개체의 상태 관계 [1]파일 다운로드1
1256정성태3/3/201233037Math: 5. Euler's totient function - C#파일 다운로드1
1255정성태3/3/201235269Math: 4. 소수 판정 및 소인수 분해 소스 코드 - C# [1]파일 다운로드1
1254정성태3/1/201230840Windows: 56. Windows 8 Consumer Preview를 사용해 보고... [1]
1253정성태3/1/201232065VS.NET IDE: 71. Visual Studio 11 Ultimate 베타 설치 [3]
1252정성태3/1/201229348Windows: 55. 윈도우 8 베타 설치 과정 [1]
1251정성태2/27/201233639VC++: 60. C/C++ Native 스레드 콜 스택 덤프를 얻는 공개 라이브러리 [2]파일 다운로드1
1250정성태2/27/201235635VC++: 59. C/C++ 프로젝트 빌드 속도 개선 - UnityBuild를 아세요? [3]
1249정성태2/26/201235878.NET Framework: 311. .NET 스레드 콜 스택 덤프 (5) - ICorDebug 인터페이스 사용법 [2]파일 다운로드3
1248정성태2/25/201246577.NET Framework: 310. C#의 Shift 비트 연산 정리파일 다운로드1
1247정성태2/25/201229350.NET Framework: 309. .NET 응용 프로그램에 기본 생성되는 스레드들에 대한 탐구 [1]파일 다운로드1
1246정성태2/25/201228690개발 환경 구성: 145. 한영 변환은 되지만, 정작 한글 입력이 안되는 경우
1245정성태2/25/201240011개발 환경 구성: 144. 윈도우에서도 유닉스처럼 명령행으로 원격 접속하는 방법
1244정성태2/24/201237025.NET Framework: 308. .NET System.Threading.Thread 개체에서 Native Thread Id를 구할 수 있을까? [1]파일 다운로드1
1243정성태2/23/201237003개발 환경 구성: 143. Visual Studio 2010 - .NET Framework 소스 코드 디버깅 - 두 번째 이야기 [1]
... 151  152  153  154  [155]  156  157  158  159  160  161  162  163  164  165  ...