PYNPM 개발자 디코딩 패키지

pip install <my-awesome-package>

package-project
├── setup.py
└── my-package
    ├── __init__.py
    └── lib.py

python3 -m venv <dir>

위의 명령은 디렉터리 <dir> 에 가상 환경을 만들었습니다. 이것은 이 디렉터리는 프로그램 실행에 필요한 모든 내용을 포함합니다. Python과 pip 버전을 포함합니다.이 디렉터리는 버전 제어에 제출할 필요가 없습니다.가상 환경을 사용하려면'활성화'해야 합니다.

source <dir>/bin/activate

요구 사항 파일

모든 가상 환경에는 자신의 pip와 Python 버전이 있습니다.그래서 당신이 시작했을 때 모든 것이 순조롭게 진행되었다.종속성을 설치할 때 다음과 같은 방법으로 종속성을 기록할 수 있습니다.

pip freeze > requirements.txt

이것은 pip에 설치된 모든 패키지와 버전을 파일requirements.txt에 기록할 것이다.파일 이름은 모든 이름이 될 수 있지만 파이썬 커뮤니티에서 이 이름을 사용하는 것은 관례입니다.파이톤에는 devdependency 개념이 없지만, 일부 항목에 대해서는 requirements-dev.txt 을 사용하여 프로젝트를 기록하는 devdependency가 적지 않다.이것은 sample requirements file입니다.
이제 프로젝트의 종속성을 다음과 같이 설치할 수 있습니다.

pip install -r requirements.txt

문서

JSDocs는 자바스크립트로 코드 문서를 작성하는 데 가장 자주 사용하는 방법이며, 문서 도구의 목록은 여기까지입니다.파이톤의 문서는 매우 중시된다.

스핑크스

Sphinx 는 파이톤 문서 생성기로서 다양한 확장을 제공하기 때문에 다양한 방식으로 사용할 수 있다.sphinx를 사용하기 위해서는 conf.py 파일이 필요합니다. sphinx의 설정을 포함합니다.sphinx-quickstart CLI 유틸리티를 사용하여 파일을 생성할 수 있습니다.다음은 sample conf.py file 시작입니다.
Sphinx와 Python 생태계는 자바스크립트 세계에서 흔히 볼 수 있는 태그가 아닌 문서reStructuredText(rest)를 선호한다.M↓ 스핑크스와 함께 사용할 수도 있지만 작업과 휴식은 M과 매우 비슷하다↓. 이것은 견본README in reST이다.

파일 열

Sphinx는 Python 코드의 특수 주석을 보고 문서에 포함할 수 있습니다.함수, 클래스 등을 설명하는 데 사용되는 주석Docstrings은 자바스크립트의 JSDocs와 자바의 자바스크립트와 매우 비슷하다.여기에는 Docstrings로 기록하는 방법이 있습니다.

def add(a, b):
  ''' Performs addition of 2 numbers

  Example:
    >>> res = add(1, 2)
    3
  Returns:
    int: Result of addition
  '''
  return a + b

docstring을 작성하는 데는 여러 가지 형식이 있는데, docstring 자체가 주제 토론이다.나는 내가 돌아왔다는 것을 발견했다this guide by RealPython. 나는 docstring을 더욱 깊이 이해하기 위해 읽어 보라고 제안했다.reSt 파일과 Docstring을 결합하여 Sphinx를 사용하여 PDF와 HTML 등의 형식의 문서를 생성할 수 있습니다.이것은 sample HTML documentation 사자 인형을 사용하여 생성된 것이다.
Sphinx는 가장 인기 있는 대체품이고, Sphinx도 가장 인기 없는 대체품이다.

ReadTheDocs 테스트

나는 성숙한 내장 도구가 있기 때문에 JavaScript로 단원 테스트를 작성하는 것보다 파이톤으로 단원 테스트를 작성하는 것이 더 쉽다는 것을 발견했다.

단원 테스트

파이톤에는 테스트를 실행할 수 있는 내장 모듈 이 있다.문법은 Jest 또는 Mocha와 매우 비슷합니다.모든'테스트'는 하나의 종류이고, 모든 종류의 방법은 하나의 테스트 용례이다.unittest와setUp() 같은 방법은 자바스크립트 테스트 프레임워크의teardown()와before 방법에 해당하는 특수한 의미를 가진다.이것은 after 입니다.테스트는 다음 사용자가 수행합니다.

python3 -m unittest discover -s <test_directory>

sample test file와Pytest는 몇 가지 대체 방안이지만, 나는 unittest가 충분하다는 것을 발견했다.

코 박사 01 명

문서 부분의 앞에서 우리는 docstring에 대해 토론했다.Docstring의 예제 섹션에서는 함수를 사용하는 방법을 보여 줍니다.가장 좋은 것은, 우리는 (또 다른 내장 모듈) 을 사용하여 자동 단원 테스트에서 이 예시를 실행할 수 있다는 것이다.이것은 문서와 실현을 동기화시킬 수 있다.

박사 01 명 출판업

패키지는 구축 후 PyPi에 게시할 수 있습니다.초기의 구축은 Egg 형식으로 이루어졌으나, 지금은 Wheel 형식으로 대체되었다.바퀴 구조를 만들려면 설치setuptools와wheel가 필요합니다.

python3 -m pip install --user --upgrade setuptools wheel

다음 명령을 실행하여 구문을 작성할 수 있습니다.

python3 setup.py sdist bdist_wheel

이렇게 하면 dist 폴더에 두 개의 파일이 생성됩니다.

확장자가 있는 소스 파일

다른 확장자.tar.gz라는 빌드 파일이 설치될 준비가 되었습니다.

이제 패키지 빌드를 PyPi에 업로드해야 합니다.우리는 이 일을 하기 위해 .whl이 필요하다.

python3 -m pip install --user --upgrade twine

마지막 단계에서 구문을 업로드합니다.

python3 -m twine upload --repository testpypi dist/*

twine 사용자 정의나 전용 npm 등록표 같은 특정한 패키지 저장소를 선택할 수 있습니다.이것은 파일을 설정할 수 있습니다.

-- 저장소 추가 자원

문제 해결에 도움이 되는 두 가지 리소스가 있습니다.

관리 .나는 네가 한번 검사해 보라고 건의한다.

Python Packaging User Guide . 나는 검색 결과에 나타난 본 사이트의 어떤 링크를 클릭하는 것을 건의합니다.

PyPi에서 제 첫 번째 패키지를 발표했을 때 모든 도전에 대응하는 것은 저에게 흥미로운 경험이었습니다.성숙한 테스트 프레임워크는 신선한 공기이다. 관계 관리와 문서 생성에 의존하는 것은 모든 다른 도구를 관리해야 하기 때문이다.마지막으로 나는 출판The Real Python을 했는데 결과에 만족한다.
만약 네가 내가 여기서 언급한 절차에 대해 어떤 문제가 있다면 반드시 평론을 발표하거나 평론을 발표해야 한다.출판 즐거움!