template package importable

개요

새로운 파이썬 기반 가져 오기 패키지를 만들 때 내부적으로 사용하는 패키지 템플릿입니다. PYPI에 새 패키지를 작성, 빌드 및 게시하는 데 필요한 모든 기본 기능과 워크 플로가 있습니다.

이 패키지 템플릿은 CLI 기능을 제공하지 않고 대신 가져 오기 가능한 패키지를 작성하도록 설계되었습니다.

우리는 사람들이 자체 도구를 만들 때 사람들이 잘 설계된 출발점을 사용할 수 있도록 다른 도구와 함께 이용할 수 있도록 결정했습니다.

우리는 또한 우리가 사용하는 2 개의 다른 템플릿을 제공합니다.

• 템플릿 파이썬 프로젝트
• 템플릿 패키지 CLI

특징

• 모듈 식 아키텍처 : 더 나은 유지 관리 가능성을 위해 코드를 모듈로 구성하십시오.
• 사용자 정의 예외 : 특정 오류 처리에 대한 사용자 정의 예외를 구현하기위한 기본 예.
• 테스트 예제 : 패키지에 대한 pytest 테스트를 작성하기위한 기본 예.

설치

가져 오기 패키지를 설치하려면 저장소를 복제하고 프로젝트 디렉토리로 이동하십시오.

git clone https://github.com/DevelopersToolbox/template-package-importable.git
cd template-package-importable

가상 환경을 사용하여 종속성을 관리하는 것이 좋습니다. 다음 명령을 사용하여 가상 환경을 생성하고 활성화 할 수 있습니다.

python -m venv venv
source venv/bin/activate  # On Windows, use `venvScriptsactivate`

필요한 종속성 설치 :

pip install -r requirements.txt

프로젝트 구조

프로젝트는 다음과 같이 구성됩니다.

template-package-importable/
├── wolfsoftware/
│   └── template_package_importable/
│       ├── __init__.py
│       ├── exceptions.py
│       └── functions.py
├── tests/
│   ├── __init__.py
│   └── test_template_package_importable.py
├── README.md
├── setup.py
└── requirements.txt

• wolfsoftware/template_package_importable : 응용 프로그램의 핵심 모듈이 포함되어 있습니다.
  • exceptions.py : 사용자 정의 예외를 처리합니다.
  • functions.py : 일부 예제 함수를 정의합니다 (테스트 용).
• tests : Pytest 테스트가 위치한 곳.
  • test_template_package_importable.py : 실행할 특정 테스트입니다.
• setup.py : 패키지 구성.
• requirements.txt : 프로젝트에 필요한 종속성을 나열합니다.
• README.md : 현재 읽고있는 파일입니다.