template package cli

Обзор

Это шаблон пакета, который мы используем внутренне при создании новых инструментов на основе Python CLI. Он имеет все основные функции и рабочие процессы, необходимые для создания, создания и публикации нового пакета в PYPI.

Этот пакет предоставляет утилиту командной строки для обработки и обработки различных задач, используя набор предопределенных аргументов и конфигураций. Проект направлен на то, чтобы служить базовой линией для разработки аналогичных приложений командной строки.

Он включает в себя такие функции, как анализ аргументов, управление конфигурацией и модульную структуру для облегчения масштабируемого и обслуживания кода.

Мы также предоставляем 2 других шаблона, которые мы используем.

• Шаблон Python Project
• Шаблонный пакет импортируется

Функции

• Модульная архитектура : организуйте свой код в модули для лучшей обслуживаемости.
• Аргумент 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 : файл, который вы читаете в настоящее время.