project
4 месяца назад
4 месяца назад
4 месяца назад
4 месяца назад
4 месяца назад
4 месяца назад
README.md
LLM Project Checker
📋 Overview
Автоматизированная система проверки и оценки проектов с использованием Large Language Models (LLM). Система реализует интеллектуальный анализ кода на основе заданных критериев оценки.
✨ Features
| Функция | Описание | Статус |
|---|---|---|
| Анализ кода | Проверка на соответствие стандартам PEP8 | ✅ |
| Оценка по критериям | 5-категорийная система оценки (15 баллов) | ✅ |
| CI/CD интеграция | Автоматическое тестирование в GitHub Actions | ✅ |
| Отчеты | Генерация детальных отчетов анализа | ✅ |
| REST API | Веб-интерфейс для проверки проектов | 🔄 |
🎯 Scoring System
| Категория | Балл | Описание |
|---|---|---|
| Полезность (Usefulness) | 4 | Функциональность и практическое применение |
| Оформление (Code Style) | 3 | Читаемость, документация, структура |
| Работоспособность (Functionality) | 4 | Корректность работы, обработка ошибок |
| README | 2 | Качество документации проекта |
| Креативность CI/CD | 2 | Инновационные решения в автоматизации |
| Итого | 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 for complete list.requirements.txt
📚 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 разработчик
- GitVerse: @sharkiss
- Проект: LLM Project Checker
📞 Support
Если у вас возникли вопросы или проблемы, пожалуйста:
- Проверьте документацию
- Посмотрите существующие issues
- Создайте новый issue с подробным описанием
Последнее обновление: 2025 | Версия: 1.0.0