project

0
4 месяца назад
4 месяца назад
4 месяца назад
4 месяца назад
README.md

LLM Project Checker

Python Version License Code Style

📋 Overview

Автоматизированная система проверки и оценки проектов с использованием Large Language Models (LLM). Система реализует интеллектуальный анализ кода на основе заданных критериев оценки.

✨ Features

ФункцияОписаниеСтатус
Анализ кодаПроверка на соответствие стандартам PEP8
Оценка по критериям5-категорийная система оценки (15 баллов)
CI/CD интеграцияАвтоматическое тестирование в GitHub Actions
ОтчетыГенерация детальных отчетов анализа
REST APIВеб-интерфейс для проверки проектов🔄

🎯 Scoring System

КатегорияБаллОписание
Полезность (Usefulness)4Функциональность и практическое применение
Оформление (Code Style)3Читаемость, документация, структура
Работоспособность (Functionality)4Корректность работы, обработка ошибок
README2Качество документации проекта
Креативность CI/CD2Инновационные решения в автоматизации
Итого15Максимальный балл

🚀 Quick Start

Installation

Usage

📁 Project Structure

project/ ├── src/ │ └── llm_project_checker.py # Main checker module ├── tests/ │ └── test_checker.py # Unit tests ├── .github/ │ └── workflows/ │ └── llm-auto-check.yml # CI/CD workflow ├── requirements.txt # Python dependencies ├── .gitignore # Git ignore rules └── README.md # This file

🔧 Dependencies

  • python: 3.8+
  • requests: HTTP client library
  • python-dotenv: Environment variable management
  • pytest: Testing framework
  • pytest-cov: Code coverage

See

requirements.txt
for complete list.

📚 Evaluation Criteria

1. Полезность (4 баллов)

  • Проект решает реальную задачу
  • Код имеет практическое применение
  • Реализованы основные функции

2. Оформление (3 балла)

  • Соответствие PEP8
  • Наличие docstrings
  • Структурированность кода

3. Работоспособность (4 балла)

  • Все функции работают корректно
  • Обработка исключений
  • Проходит автоматические тесты

4. README (2 балла)

  • Полное описание проекта
  • Инструкции по установке и использованию
  • Примеры кода

5. Креативность CI/CD (2 балла)

  • Автоматизация тестирования
  • Проверка кода стиля
  • Интеграция с анализаторами

🔄 CI/CD Pipeline

Проект использует GitHub Actions для автоматизации:

🧪 Testing

📖 Documentation

Полная документация доступна в файле

llm-checker-guide.md
в исходном репозитории.

🤝 Contributing

Приветствуются pull requests и issues. Для больших изменений сначала откройте issue для обсуждения.

📝 License

Этот проект лицензирован под MIT License - смотрите файл LICENSE для деталей.

👨‍💻 Author

Sharkiss - GitHub разработчик

📞 Support

Если у вас возникли вопросы или проблемы, пожалуйста:

  1. Проверьте документацию
  2. Посмотрите существующие issues
  3. Создайте новый issue с подробным описанием

Последнее обновление: 2025 | Версия: 1.0.0