Python Project Template

Шаблон для быстрого старта Python-проектов с настроенной средой разработки и инфраструктурой. В шаблоне уже включены и преднастроены все необходимые инструменты для профессиональной разработки.

🛠 Включенные инструменты

• Ruff - быстрый Python линтер и форматтер кода
• BasedPyright - Улучшенный форк статического анализатора типов от Microsoft
• Docker и docker-compose для контейнеризации
• .env файлы для управления переменными окружения

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

1. Склонируйте репозиторий

git clone https://github.com/yourusername/python-project-template.git new-project
cd new-project

2. Создайте и активируйте виртуальное окружение

pip3 install uv  # Установка сверхбыстрого менеджера пакетов uv
uv init  # Иницализация проекта с помощью uv
uv venv && source .venv/bin/activate  # Активация виртуального окружения

3. Скопируйте .env.dist в .env и настройте переменные окружения

cp .env.dist .env

🔧 Установка и настройка инструментов

Ruff

1. Установка:

pip install ruff

2. Конфигурация уже включена в ruff.toml:

• Автоматическое форматирование кода
• Проверка импортов
• Линтинг кода
• Сортировка импортов

3. Использование:

ruff check .  # проверка кода
ruff format .  # форматирование кода

BasedPyright

1. Установка:

pip install basedpyright

2. Конфигурация включена в pyrightconfig.json:

• Строгая проверка типов
• Настроенные пути к исходному коду
• Игнорирование виртуального окружения

3. Использование:

basedpyright  # проверка типов в проекте

Pre-commit

Для автоматической проверки кода перед коммитом:

pip install pre-commit

pre-commit install

🐳 Docker

Для запуска проекта в контейнере:

docker-compose up --build

🔍 Структура проекта

.
├── .dockerignore          # Исключения для Docker
├── .env.dist             # Шаблон переменных окружения
├── .gitignore            # Исключения для Git
├── Dockerfile            # Сборка Docker образа
├── README.md             # Документация проекта
├── docker-compose.yaml   # Конфигурация Docker Compose
├── pyrightconfig.json    # Настройки Pyright
└── ruff.toml            # Настройки Ruff

📋 Рекомендации по использованию

1. Используйте этот шаблон для новых Python проектов
2. Следуйте структуре проекта для поддержания единообразия
3. Регулярно обновляйте зависимости
4. Соблюдайте правила форматирования кода

🤝 Вклад в проект

Мы приветствуем вклад в развитие шаблона! Если у вас есть предложения по улучшению:

1. Сделайте форк репозитория
2. Создайте ветку для ваших изменений
3. Отправьте pull request