Merge branch 'main' into hyperion/artemis-integration

Author: FelixTJDietrich

README.md

@@ -6,29 +6,33 @@ EduTelligence is a comprehensive suite of AI-powered microservices designed to e
 
 EduTelligence maintains compatibility with different versions of [Artemis](https://github.com/ls1intum/Artemis). The following table shows the compatibility matrix:
 
-| Artemis Version | EduTelligence Version | Status |
-|-----------------|----------------------|---------|
-| 8.0.x | 1.0.x | ✅ Stable |
-| 8.1.x | 1.1.x | ✅ Stable |
+| Artemis Version | EduTelligence Version | Status    |
+| --------------- | --------------------- | --------- |
+| 8.0.x           | 1.0.x                 | ✅ Stable |
+| 8.1.x           | 1.1.x                 | ✅ Stable |
 
 > **Note:** Always ensure you're using compatible versions for optimal integration and functionality.
 
 ## 🚀 Sub-Services Overview
 
 ### 🤖 [Iris](./iris/) - AI Virtual Tutor
+
 **Pyris** - An intermediary system that connects Artemis with various Large Language Models (LLMs) to power Iris, a virtual AI tutor.
 
 **Key Features:**
+
 - **Exercise Support**: Provides intelligent feedback on programming exercises
 - **Course Content Support**: Uses RAG (Retrieval-Augmented Generation) for detailed course content explanations
 - **Competency Generation**: Automates the creation of course competencies
 
 **Technology Stack:** Python 3.12, Poetry, FastAPI, Weaviate (Vector DB)
 
 ### ⚡ [Hyperion](./hyperion/) - AI Exercise Creation Assistant
+
 AI-driven programming exercise creation assistance that illuminates the process of creating engaging, effective programming exercises.
 
 **Key Features:**
+
 - **Problem Statement Refinement**: AI-powered improvement of exercise descriptions
 - **Code Stub Generation**: Automatic generation of starter code templates
 - **Context-Aware Suggestions**: Intelligent recommendations for exercise improvement
@@ -37,9 +41,11 @@ AI-driven programming exercise creation assistance that illuminates the process
 **Technology Stack:** Python 3.13, Poetry, gRPC, Docker
 
 ### 🏛️ [Athena](./athena/) - Automated Assessment System
+
 A sophisticated system designed to provide (semi-)automated assessments for various types of academic exercises.
 
 **Key Features:**
+
 - **Multi-Exercise Support**: Text exercises, programming exercises, and planned UML/math support
 - **LMS Integration**: Efficient evaluation for large courses
 - **Advanced Assessment**: AI-powered grading and feedback generation
@@ -49,9 +55,11 @@ A sophisticated system designed to provide (semi-)automated assessments for vari
 **Documentation:** [ls1intum.github.io/Athena/](https://ls1intum.github.io/Athena)
 
 ### 🗺️ [Atlas](./atlas/) - Adaptive Competency-Based Learning
+
 A microservice that incorporates competency models into Learning Management Systems using machine learning and generative AI.
 
 **Key Features:**
+
 - **AI-Powered Competency Models**: Automatic generation of sophisticated competency frameworks
 - **Relationship Mapping**: Automated relationships between competencies
 - **Learning Activity Recommendations**: AI-driven suggestions for linking competencies to activities
@@ -60,9 +68,11 @@ A microservice that incorporates competency models into Learning Management Syst
 **Technology Stack:** Python, Machine Learning, GenAI/LLMs
 
 ### 📊 [Logos](./logos/) - LLM Engineering Platform
+
 A comprehensive LLM Engineering Platform that provides centralized management and monitoring for AI services.
 
 **Key Features:**
+
 - **Usage Logging**: Comprehensive tracking of LLM usage
 - **Billing Management**: Cost tracking and billing for AI services
 - **Central Resource Management**: Unified management of AI resources
@@ -72,13 +82,15 @@ A comprehensive LLM Engineering Platform that provides centralized management an
 **Technology Stack:** Python 3.13, Poetry, FastAPI, Docker
 
 ### 🌌 [Nebula](./nebula/) - [In Development]
-*Documentation and features coming soon*
+
+_Documentation and features coming soon_
 
 **Technology Stack:** Python, Poetry
 
 ## 🚀 Quick Start
 
 ### Prerequisites
+
 - **Python 3.12+** (3.13 recommended for newer services)
 - **Poetry** for dependency management
 - **Docker & Docker Compose** for containerization
@@ -87,6 +99,7 @@ A comprehensive LLM Engineering Platform that provides centralized management an
 ### Installation
 
 1. **Clone the repository:**
+
    ```bash
    git clone https://github.com/ls1intum/edutelligence.git
    cd edutelligence
@@ -128,4 +141,86 @@ This project is licensed under the **MIT License** - see the [LICENSE](LICENSE)
 
 - **Issues**: [GitHub Issues](https://github.com/ls1intum/edutelligence/issues)
 - **Discussions**: [GitHub Discussions](https://github.com/ls1intum/edutelligence/discussions)
-- **Documentation**: Individual service READMEs and documentation
+- **Documentation**: Individual service READMEs and documentation
+
+# API Endpoints Finalization and Code Quality Improvements
+
+## What?
+
+- Finalized API endpoints for integration
+- Introduced code quality tools (Black and Ruff)
+
+## Why?
+
+- To establish a consistent and well-defined API structure
+- To improve code quality and maintainability through automated linting
+
+## How?
+
+- Defined and documented all necessary endpoints
+- Integrated Black for code formatting
+- Added Ruff for Python linting
+
+## Affected Issues & Feature Proposal
+
+Closes #[issue_number]
+
+## Checklist
+
+### General
+
+- [x] Chose a title conforming to the naming conventions for pull requests
+- [x] Updated API documentation
+- [x] Added linting configuration files
+
+### Testing
+
+- [x] Verified all endpoints are working as expected
+- [x] Ensured linting rules are properly applied
+
+### Testing Instructions
+
+1. Run Black to format code:
+   ```bash
+   black .
+   ```
+2. Run Ruff to check code quality:
+   ```bash
+   ruff check .
+   ```
+
+## Review Progress
+
+- [ ] Code Review 1
+- [ ] Code Review 2
+
+## Summary of Changes
+
+### New Features
+
+- Defined and documented all API endpoints for integration
+- Added comprehensive API documentation
+
+### Improvements
+
+- Introduced Black for consistent code formatting
+- Added Ruff for enhanced Python linting
+- Improved code quality through automated checks
+
+### Configuration
+
+- Added `.black` configuration file
+- Added `ruff.toml` configuration file
+- Updated development dependencies
+
+### Documentation
+
+- Updated API documentation with endpoint specifications
+- Added linting setup instructions
+- Included code style guidelines
+
+## Next Steps
+
+- Monitor linting results in CI/CD pipeline
+- Gather feedback on API endpoint structure
+- Consider additional code quality tools if needed