template package importable

Обзор

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

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

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

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

• Шаблон Python Project
• Шаблонный пакет 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 : файл, который вы читаете в настоящее время.