template package cli

개요

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

이 패키지는 사전 정의 된 인수 및 구성 세트를 사용하여 다양한 작업을 처리하고 처리하기위한 명령 줄 유틸리티를 제공합니다. 이 프로젝트는 유사한 명령 줄 애플리케이션을 개발하기위한 기준으로 사용하는 것을 목표로합니다.

여기에는 인수 구문 분석, 구성 관리 및 모듈 식 구조와 같은 기능이 포함되어 있으며 확장 가능하고 유지 관리 가능한 코드 개발을 용이하게합니다.

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

• 템플릿 파이썬 프로젝트
• 템플릿 패키지 수입 가능

특징

• 모듈 식 아키텍처 : 더 나은 유지 관리 가능성을 위해 코드를 모듈로 구성하십시오.
• 인수 구문 분석 : argparse 사용하여 명령 줄 인수를 쉽게 처리합니다.
• 구성 관리 : 명령 줄 인수에서 구성 객체를 생성합니다.
• 사용자 정의 예외 : 특정 오류 처리에 대한 사용자 정의 예외를 구현합니다.

설치

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

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

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

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

필요한 종속성 설치 :

pip install -r requirements.txt

용법

CLI 패키지를 실행하려면 기본 스크립트에서 main 기능을 실행하십시오.

python -m wolfsoftware.template_package_cli.main --required < value >

명령 줄 주장

응용 프로그램은 여러 명령 줄 인수를 지원합니다.

• -h, --help : 도움말 메시지와 종료.
• -d, --debug : 장점 출력에 대한 디버그 모드를 활성화합니다.
• -v, --verbose : 동점 출력을 활성화하여 스캔 결과가 들어올 때 스캔 결과를 표시합니다.
• -V, --version : 프로그램의 버전 번호를 보여주고 종료하십시오.
• -i, --optional-integer : 선택적 정수 인수 (기본값 : 2).
• -s, --optional-string : 선택적 문자열 인수 (기본값 : "me").
• -r, --required : 필요한 문자열 인수.

예제 사용 :

python -m wolfsoftware.template_package_cli.main -r " required_value " -i 10 -s " optional_string " 

프로젝트 구조

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

template-package-cli/
├── wolfsoftware/
│   └── template_package_cli/
│       ├── __init__.py
│       ├── cli.py
│       ├── config.py
│       ├── exceptions.py
│       ├── globals.py
│       └── main.py
├── README.md
├── setup.py
└── requirements.txt

• wolfsoftware/template_package_cli : 응용 프로그램의 핵심 모듈이 포함되어 있습니다.
  • cli.py : 명령 줄 인수 및 주요 프로그램 흐름을 처리합니다.
  • config.py : 명령 줄 인수에서 구성 작성을 처리합니다.
  • exceptions.py : 사용자 정의 예외를 처리합니다.
  • globals.py : 응용 프로그램에서 사용되는 글로벌 상수를 정의합니다.
  • main.py : 인수 구문 분석 및 프로그램 실행을 조율하는 메인 스크립트.
• requirements.txt : 프로젝트에 필요한 종속성을 나열합니다.
• README.md : 현재 읽고있는 파일입니다.