bootstrap python package

Bootstrap-Python-Package

Этот репозиторий шаблона обеспечивает шаблон для создания пакета Python. Он настроен со всеми следующими функциями:

• Test Suite с использованием Tox и Pytest
• Набирая с помощью mypy
• Линтинг, безопасность и формат кода с использованием ruff (используя правила стиля черного кода и правила безопасности бандита)
• Интеграция с Codeclimate для качества кода и проверки покрытия
• CI Pipeline поддерживает:
  • Тестирование на несколько версий Python
  • Выпуски на PYPI
  • Документация GitHub Pages с использованием mkdocs
• Pycharm Profile Basic Configuration

Как использовать этот шаблон репозитория для создания нового пакета

• Создайте репозиторий GitHub, используя этот шаблон. (Большой зеленый Use this template )
• Переименовать каталог bootstrap_python_package
• Поиск и замените все случаи bootstrap-python-package и bootstrap_python_package
• Настройте ожидающего доверенного издателя на PYPI, используя следующие значения:
  • Имя проекта PYPI: имя репозитория GitHub (в данном случае bootstrap-python-package )
  • Владелец: владелец репозитория GitHub (в данном случае febus982 )
  • Имя репозитория: имя репозитория GitHub (в данном случае bootstrap-python-package )
  • Название рабочего процесса: release.yml
• Создайте секретную github secret с именем CODECLIMATE_REPORTER_ID (at url https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions ), содержащий идентификатор репортера Codeclimate (вы можете найти в https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter ). Если вы не хотите использовать Codeclimate, просто удалите workflows/python-quality.yml .
• Обновите значки в README.md ! (Проверьте shields.io для дополнительных значков)
• Обновите профиль авторских прав Pycharm в настройках IDE: редактор | Авторское право | Профили авторских прав (если вы хотите его использовать)
• Настройка локальной разработки:
  • Клонировать репозиторий
  • Установите стихи pip install poetry
  • Установите зависимости Dev с помощью make dev-dependencies
  • (Необязательно) Настоятельно рекомендуется установить предварительную коммиту и запустить pre-commit install , чтобы форматирование и лининг автоматически выполнялись во время git commit .
• Настройка страниц GitHub (это необходима локальная настройка разработки):
  • Инициализация документации филиала poetry run mike deploy dev latest --update-aliases --push
  • Настройте страницы GitHub для развертывания из филиала gh-pages (по адресу url https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages )
  • Добавьте main филиал и v*.*.* Правила тега в список развертывания и теги »в среде gh-pages (по адресу url https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/environments )

Важно: репозиторий настроен для развертывания в тестовом репозитории PYPI. Настоятельно рекомендуется создать проект в тестовом хранилище PYPI и протестировать конвейер развертывания. Когда вы довольны результатом, создайте проект на официальном репозитории PYPI и удалите отмеченные линии в workflows/release.yml .

Выпуск пакета

В этой настройке используется поэзия-динамическая версия. Это означает, что нет необходимости совершать версию в коде, но трубопровод CI выведет ее из тега GIT.

Чтобы выпустить новую версию, просто создайте новый выпуск и теги в репозитории GitHub, чтобы:

• Создайте и разверните пакет Python в PYPI
• Создайте и разверните новую версию документации на страницы GitHub

ВАЖНО: Конфигурация по умолчанию требует, чтобы имя выпуска и тег следовал за соглашением vX.XX (семантическое управление версией, которым предшествует нижняя часть v ). Он опубликует правильную версию на PYPI, пропуская v (т.е. v1.0.0 , опубликует 1.0.0 ).

Этот формат можно настроить, обратитесь к документам-поэзии-динамической версии

Команды для разработки

Все общие команды, используемые во время разработки, могут быть запущены с использованием целей: цели:

• make dev-dependencies : установить требования DEV
• make update-dependencies : обновление требований DEV
• make fix : запустите стиль кода и автоматические исправления Lint (где это возможно)
• make test : запустите тестовый набор против версии System Python
• make check : запустите тесты на все доступные версии Python, стиль кода и проверки ворса
• make type , make format , make lint , make bandit : запустите соответствующую проверку
• make docs : рендеринг веб -сайта MKDOCS локально