cookiecutter hatch pypackage

cookiecutter hatch pypackage

Шаблон Cookiecutter для передового пакета Python: Hatch , ruff , mypy , GitHub Actions и многое другое!

Подробности
Функции

Функции

• Легкий стартер
• Управление пакетами Hatch
• Hatch-vcs: автоматическое определение версии пакета по тегам git, например v0.9
• Линтинг и форматирование ruff , который заменяет isort, flake8, black и т.д.
• Проверка типа с помощью mypy
• Проверьте неиспользуемые, отсутствующие и транзитивные зависимости с помощью deptry
• Юнит-тесты с помощью pytest с дополнительной настройкой asyncio.
• Автоматизируйте и стандартизируйте тестирование с помощью Hatch-env-матриц.
• Документация с материалом для MkDocs и поддержка справочной информации по строкам документации с помощью mkdocstrings.
• Готовые к использованию конвейеры действий GitHub с dependabot , release-drafter , labeler , publish to PYPI workflows , publish to test PYPI workflows и многим другим.
• Hatch-pip-compile: экспериментальная поддержка файлов блокировки,
• pyproject.toml: все настройки пакетов, сборок и инструментов в одном файле,
• покрытие: инструмент для измерения покрытия кода программ Python с интеграцией pytest,
• pre-commit: git-хуки для предварительной фиксации, которые сделают вашу жизнь проще,
• Markdown: вместо reStructuredText Markdown используется последовательно для всех текстовых файлов.
• EditorConfig: поддержка единообразных стилей кодирования для нескольких разработчиков.
• src-layout: фактический пакет Python хранится в папке src , что позволяет избежать многих распространенных ошибок.

? Быстрый старт

Сгенерируйте проект:

В этом проекте pipx будет использоваться для установки hatch в изолированной среде. Прежде чем запускать следующую команду, убедитесь, что у вас установлен pipx .

cookiecutter https://github.com/Aviksaikat/cookiecutter-hatch-pypackage

Генератор автоматически вызовет hatch env create & git init в конце.

Затем, чтобы GitHub Actions pipelines работали правильно, вам следует:

• Включите репозиторий GitHub в Codecov .
• Установите CODECOV_TOKEN в секретах вашего репозитория GitHub. Найти можно в настройках Codecov соответствующего проекта.
• Включите GitHub Pages используя источник GitHub Actions .
• Возможность публикации в Test PyPI для тестирования.
• Настройте метод Trusted Publisher в PyPI: это современный и безопасный метод отправки вашего пакета в PyPI.

С хламом

Cruft — это слой над Cookiecutter, позволяющий обновить проект на основе шаблона после его создания.

cruft create https://github.com/Aviksaikat/cookiecutter-hatch-pypackage

Демо

Лицензия

Этот проект лицензируется на условиях лицензии MIT.