Об этом проекте
Copier-python — это шаблон Copier для создания новых Python-проектов с уже настроенным современным и определенным набором инструментов. Он используется из командной строки для генерации проекта по выбранному пути и не является библиотекой времени выполнения.
Быстрый старт
- Установите необходимые компоненты: mise-en-place для управления инструментарием и сам Copier (например, через `mise use -g copier` или `uv tool install copier`).
- Сгенерируйте проект с помощью команды `copier copy "gh:smkent/copier-python" /new/project/path`.
- Сайт с документацией содержит требования и подробности по дальнейшему использованию.
Включенные инструменты
- mise-en-place ("mise") для управления инструментарием разработки.
- Набор инструментов Astral: uv, ruff и ty.
- prek, обеспечивающий git-хуки, совместимые с pre-commit.
- pytest в качестве фреймворка для тестирования с поддержкой codecov.io.
- Zensical для документации проекта с автоматическим развертыванием на GitHub Pages.
Обновление и автоматизация релизов
- Обновления проекта поддерживаются через Renovate вместе с `copier update`, что позволяет сгенерированным проектам подтягивать изменения из шаблона.
- Автоматизация релизов включает публикацию пакета в PyPI и сборку образа контейнера с помощью GitHub Actions.
Благодарности
В шаблоне указано, что он был вдохновлен pawamoy/copier-uv и ritwiktiwari/copier-astral. Он распространяется под лицензией, включенной в репозиторий, а также опубликован в PyPI как copier-python.
Для кого это предназначено
Для разработчиков, которым нужна повторяемая отправная точка для Python-пакетов и приложений с изначально настроенным управлением зависимостями, линтингом/форматированием, git-хуками, тестированием, документацией и CI-релизами, а также для тех, кто хочет, чтобы сгенерированные проекты оставались обновляемыми при изменении шаблона.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.