Skip to content

Latest commit

 

History

4 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Python UV Project Template (Copier)

Шаблон Copier для быстрого старта Python‑проекта с uv, Ruff, pre-commit, EditorConfig и готовыми рекомендациями для VS Code.

Требования

  • Python 3.9+
  • copier (pipx install copier)
  • proto для установки uv

Как использовать

  1. Склонируйте репозиторий или укажите путь к шаблону.
  2. Сгенерируйте проект:
    copier copy --trust gh:TiMirLAN/pyup-template ./my-project
  3. Ответьте на вопросы:
    • project_name — имя проекта (по умолчанию название папки).
    • project_description — описание проекта.
    • init_git_repo — инициализировать git?
    • init_uv_environment — настроить окружение через uv?
    • uv_type — тип проекта (app, lib, script, если выбран uv).
    • uv_use_package — настроить окружение для сборки python-пакета (для uv).
    • install_tool_ruff — установить Ruff.
    • install_tool_pre_commit — установить pre-commit (если есть git).

Что делает шаблон

  • Генерирует базовую структуру через uv init с описанием и выбранным типом проекта.
  • Создаёт виртуальное окружение uv venv.
  • Устанавливает Ruff и pre-commit (через uv tool install или pipx, если uv не выбран).
  • Инициализирует git (по желанию) и включает pre-commit хуки, запускает проверку pre-commit run --all-files.
  • Добавляет готовые конфиги: .pre-commit-config.yaml, .ruff.toml, .editorconfig, .gitignore, настройки VS Code с рекомендациями расширений.

Полезные команды после генерации

  • Запуск форматирования и lint: pre-commit run --all-files
  • Обновление окружения: uv sync
  • Установка доп. инструментов: uv tool install <pkg>

Лицензия

MIT (при необходимости добавьте файл LICENSE в сгенерированный проект).

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors