code-analyser 0.1.0__py3-none-any.whl

code_analyser-0.1.0.dist-info/METADATA

@@ -0,0 +1,283 @@
+Metadata-Version: 2.4
+Name: code-analyser
+Version: 0.1.0
+Summary: Automated Code Analysis & Grading Assistant for Educators
+Project-URL: Homepage, https://github.com/yourusername/codelens
+Project-URL: Repository, https://github.com/yourusername/codelens.git
+Author: CodeLens Team
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Education
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Requires-Dist: aiosqlite>=0.19.0
+Requires-Dist: alembic>=1.13.0
+Requires-Dist: docker>=6.1.0
+Requires-Dist: fastapi>=0.104.0
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: mypy>=1.7.0
+Requires-Dist: passlib[bcrypt]>=1.7.4
+Requires-Dist: pydantic-settings>=2.1.0
+Requires-Dist: pydantic>=2.5.0
+Requires-Dist: python-jose[cryptography]>=3.3.0
+Requires-Dist: python-multipart>=0.0.6
+Requires-Dist: ruff>=0.1.0
+Requires-Dist: sqlalchemy>=2.0.0
+Requires-Dist: structlog>=23.2.0
+Requires-Dist: uvicorn[standard]>=0.24.0
+Provides-Extra: dev
+Requires-Dist: black>=23.11.0; extra == 'dev'
+Requires-Dist: isort>=5.12.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.5.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
+Requires-Dist: pytest>=7.4.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# CodeLens
+
+<!-- BADGES:START -->
+[![edtech](https://img.shields.io/badge/-edtech-4caf50?style=flat-square)](https://github.com/topics/edtech) [![automated-grading](https://img.shields.io/badge/-automated--grading-blue?style=flat-square)](https://github.com/topics/automated-grading) [![code-analysis](https://img.shields.io/badge/-code--analysis-blue?style=flat-square)](https://github.com/topics/code-analysis) [![docker](https://img.shields.io/badge/-docker-2496ed?style=flat-square)](https://github.com/topics/docker) [![education](https://img.shields.io/badge/-education-blue?style=flat-square)](https://github.com/topics/education) [![fastapi](https://img.shields.io/badge/-fastapi-009688?style=flat-square)](https://github.com/topics/fastapi) [![microservice](https://img.shields.io/badge/-microservice-blue?style=flat-square)](https://github.com/topics/microservice) [![plagiarism-detection](https://img.shields.io/badge/-plagiarism--detection-blue?style=flat-square)](https://github.com/topics/plagiarism-detection) [![python](https://img.shields.io/badge/-python-3776ab?style=flat-square)](https://github.com/topics/python) [![static-analysis](https://img.shields.io/badge/-static--analysis-blue?style=flat-square)](https://github.com/topics/static-analysis)
+<!-- BADGES:END -->
+
+**Automated Code Analysis & Grading Assistant for Educators**
+
+CodeLens is a comprehensive microservice designed to help educators analyze, validate, and grade student code submissions across multiple programming languages. It provides automated analysis, plagiarism detection, sandboxed code execution, and detailed feedback generation.
+
+## 🚀 Features
+
+### Core Analysis
+- **Static Code Analysis**: Syntax validation, style checking, complexity metrics
+- **Configurable Tools**: Support for ruff, mypy, and other analysis tools
+- **Multi-language Support**: Currently supports Python with extensible architecture
+- **Quality Metrics**: Lines of code, cyclomatic complexity, maintainability index
+
+### Code Execution
+- **Secure Sandboxing**: Docker-based isolated execution environment
+- **Test Execution**: Support for pytest and unittest frameworks
+- **Resource Limits**: CPU, memory, and time constraints for safety
+- **Input/Output Validation**: Compare expected vs actual outputs
+
+### Plagiarism Detection
+- **Multiple Methods**: AST structural, token-based, line-based similarity
+- **Cross-submission Comparison**: Compare against other student submissions
+- **Configurable Thresholds**: Adjustable similarity detection sensitivity
+- **Review System**: Manual review and flagging of potential plagiarism
+
+### Batch Processing
+- **Directory Processing**: Analyze entire folders of submissions
+- **Parallel Processing**: Concurrent analysis for improved performance
+- **Student Info Extraction**: Automatic extraction of student IDs from filenames
+- **CLI Interface**: Command-line tools for instructors
+
+### Grading & Feedback
+- **Rubric-based Grading**: Configurable grading criteria and weights
+- **Automated Scoring**: Calculate grades based on multiple factors
+- **Detailed Feedback**: Constructive comments and improvement suggestions
+- **Progress Tracking**: Track student performance over time
+
+## 🏗️ Architecture
+
+```
+codelens/
+├── api/                 # FastAPI routes and schemas
+├── analyzers/           # Code analysis engines
+├── services/            # Business logic services
+├── models/              # Database models
+├── db/                  # Database configuration
+├── core/                # Configuration and settings
+└── utils/               # Utility functions
+```
+
+## 🛠️ Installation
+
+1. **Clone the repository**
+```bash
+git clone <repository-url>
+cd code-lens
+```
+
+2. **Install dependencies**
+```bash
+pip install -e .
+```
+
+3. **Install analysis tools**
+```bash
+pip install ruff mypy pytest
+```
+
+4. **Setup Docker** (for code execution)
+```bash
+docker pull python:3.11-slim
+```
+
+5. **Initialize database**
+```bash
+python -m codelens.main
+```
+
+## 🚀 Quick Start
+
+### Web API Server
+
+Start the FastAPI server:
+
+```bash
+# Development mode
+uvicorn codelens.main:app --reload
+
+# Production mode
+uvicorn codelens.main:app --host 0.0.0.0 --port 8000
+```
+
+The API will be available at `http://localhost:8003` with documentation at `/docs`.
+
+### CLI Usage
+
+Analyze a single file:
+```bash
+python -m codelens analyze submission.py --student-id cs123456
+```
+
+Process a directory of submissions:
+```bash
+python -m codelens batch /path/to/submissions --language python --detailed
+```
+
+Generate batch report:
+```bash
+python -m codelens batch /submissions --output results.json --rubric-id 1
+```
+
+## 📡 API Examples
+
+### Analyze Python Code
+```bash
+curl -X POST "http://localhost:8003/api/v1/analyze/python" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "code": "def hello():\n    print(\"Hello, World!\")",
+    "language": "python",
+    "student_id": "cs123456",
+    "check_similarity": true,
+    "run_tests": false
+  }'
+```
+
+### Batch Analysis
+```bash
+curl -X POST "http://localhost:8003/api/v1/analyze/batch" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "files": [
+      {"code": "def add(a, b): return a + b", "path": "student1.py"},
+      {"code": "def multiply(x, y): return x * y", "path": "student2.py"}
+    ],
+    "language": "python",
+    "check_similarity": true
+  }'
+```
+
+### Create Rubric
+```bash
+curl -X POST "http://localhost:8003/api/v1/rubrics/" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "name": "Python Assignment 1",
+    "language": "python",
+    "criteria": {"functionality": 40, "style": 30, "documentation": 30},
+    "weights": {"functionality": 0.4, "style": 0.3, "documentation": 0.3},
+    "total_points": 100
+  }'
+```
+
+## ⚙️ Configuration
+
+Configuration is managed through environment variables and the `codelens/core/config.py` file:
+
+```python
+# Analysis tools
+RUFF_ENABLED=true
+MYPY_ENABLED=true
+MAX_LINE_LENGTH=88
+
+# Execution limits
+EXECUTION_TIMEOUT=30
+MEMORY_LIMIT=128m
+CPU_LIMIT=0.5
+
+# Similarity detection
+SIMILARITY_ENABLED=true
+SIMILARITY_THRESHOLD=0.8
+
+# Database
+DATABASE_URL=sqlite+aiosqlite:///./codelens.db
+```
+
+## 🔒 Security
+
+- **Sandboxed Execution**: All code runs in isolated Docker containers
+- **Resource Limits**: CPU, memory, and time constraints prevent abuse
+- **No Network Access**: Containers run without network connectivity
+- **Input Validation**: All inputs are validated and sanitized
+- **Code Analysis Only**: Original submissions are not stored permanently
+
+## 📊 Supported Analysis
+
+### Python
+- **Linting**: ruff (configurable rules)
+- **Type Checking**: mypy (optional)
+- **Metrics**: Complexity, maintainability, documentation coverage
+- **Testing**: pytest, unittest support
+- **Similarity**: AST-based structural comparison
+
+### Future Languages
+The architecture supports extension to JavaScript, HTML/CSS, Java, and other languages.
+
+## 🤝 Educational Use Cases
+
+- **Introductory Programming Courses**: Automated grading for basic assignments
+- **Code Quality Assessment**: Teaching best practices and style guidelines
+- **Plagiarism Detection**: Identifying potential academic dishonesty
+- **Progress Tracking**: Monitoring student improvement over time
+- **Immediate Feedback**: Helping students learn from mistakes
+
+## 📈 Example Workflow
+
+1. **Instructor**: Creates assignment with rubric
+2. **Students**: Submit code files (via LMS or direct upload)
+3. **CodeLens**: Analyzes submissions automatically
+4. **System**: Generates grades and detailed feedback
+5. **Instructor**: Reviews flagged similarities and edge cases
+6. **Students**: Receive feedback and suggestions for improvement
+
+## 🧪 Testing
+
+Run the test suite:
+```bash
+pytest tests/
+```
+
+Run with coverage:
+```bash
+pytest --cov=codelens tests/
+```
+
+## 📝 License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## 🙏 Acknowledgments
+
+- Built with FastAPI for high-performance web APIs
+- Uses Docker for secure code execution
+- Powered by ruff and mypy for Python analysis
+- Inspired by the need for fair and consistent code grading
+
+---
+
+**CodeLens**: Empowering educators with intelligent code analysis 🔍✨

code_analyser-0.1.0.dist-info/RECORD

@@ -0,0 +1,34 @@
+codelens/__init__.py,sha256=sx1HI1jOpPOML0ACWaCe1Hp1Kdu2K6lswGk9zRDhoV8,207
+codelens/__main__.py,sha256=4_KQpQu_5Z0VSvejCIvAGjnMEVgo8fMpaWuRYHAWVYE,431
+codelens/cli.py,sha256=w5haGGK7xaril4zcxdCIzks54GDcxRBn5SwEbVqd8Bg,11799
+codelens/main.py,sha256=rdjDKtbCMWZmq87KkznFxrmt1LVcHs8lTbbMc1ZC6kw,2999
+codelens/analyzers/__init__.py,sha256=rbtiHE0yEmuf0OxHTBoxfeuGVNXWNiCV5IlBYYcvRbg,749
+codelens/analyzers/base.py,sha256=f0dglJCP-bYKhQjJlh5nL8qM5S_X0Xl8L8ir1oQnWAM,4259
+codelens/analyzers/manager.py,sha256=UaNO7o7UZh1AtT9gKBSuqqtSBWBInDSwzJAJB5NDmGs,7043
+codelens/analyzers/python_analyzer.py,sha256=SyES-FlJKvkFxryztcQUkVM7DPT90O9ff2nREZFCRFk,13368
+codelens/analyzers/similarity_analyzer.py,sha256=sp-sFpheTeRrARS-S7wGj5EX9pWEzm8E37poZDJ-9I8,18864
+codelens/api/__init__.py,sha256=Mow0Ffn6nVs3QDEXSEZHOMWwKmSBMeSxduYjJt9CjkA,31
+codelens/api/schemas.py,sha256=Dd9xNP5T5p4eiJpBe3byLO0yBRLJnOF32jDCZaDqsL4,10939
+codelens/api/routes/__init__.py,sha256=JXHLVi48XM5_zVjoBSyHvUWqT4XDhkHP9X_cjMLbk8c,24
+codelens/api/routes/analysis.py,sha256=NEmYUoRHth_-wOnHKddzjT6-6EdaKPSjvuG0oglPUIc,17035
+codelens/api/routes/reports.py,sha256=Vd-7S3PfeXXlB-X0MPtZEEK6FnlGb9Y_0LqS9U2JsPE,14539
+codelens/api/routes/rubrics.py,sha256=rhFE9c547xhLk93Ip-XaypU4PZcuOkYcBsuXgWHvNLg,11562
+codelens/core/__init__.py,sha256=Xls_Bpc6QdAjMS_pbplPEzHjHuAtjtwaK0Dld0iTD-A,34
+codelens/core/config.py,sha256=-NNVDeimo3yPhLHU9M8pOiAIb8Lw0R2ECWETMq0R7Jg,2348
+codelens/db/__init__.py,sha256=20e81aCej9FuAojE6v5ATpfrueelBUXRXlvFIY6IYo0,44
+codelens/db/database.py,sha256=9f4zQDdemrIJgNgzhiUC-7lnsck4kq34SkDQr58-fU8,1440
+codelens/models/__init__.py,sha256=QtfavOkLD6nvBF8ggCG2KBSvwujDmlDAWXJ9vM7L7sw,298
+codelens/models/assignments.py,sha256=2OzS45_C9jrDgtfeSvvLbOa71wfQ76SBBNM560ivNjY,3999
+codelens/models/reports.py,sha256=cIff31nGdmB4kJy-udEsLRRFHEFZ_EcyX0ZOFW3O8dI,6266
+codelens/models/rubrics.py,sha256=y4HrPyYb5AA7Dnvf2FV7q6a5DQHL3QKluJzqAj7xVuw,2826
+codelens/services/__init__.py,sha256=W5iKEV_YDcKrznlOLeqRj0CAiT5HdBhhjQoHrv8l4kc,859
+codelens/services/batch_processor.py,sha256=TcSUkacWg1Qz1J7W3w0f31kyggSucMzl6KUxDxngPyc,17739
+codelens/services/code_executor.py,sha256=bC2pqColCTeB7jcUbPTK5_mjah0TWbwXoLjY0EFCJvU,10862
+codelens/services/sandbox.py,sha256=Oho5E43M1nYYUHh70wKuF9dLlMwFqTvcmI0Kp29Qj98,14059
+codelens/services/similarity_service.py,sha256=vZu9OSCf6e1efp3NUmouYjCT1I3Rl-tMysI_iL11ekM,16549
+codelens/utils/__init__.py,sha256=-rjYOnL-A4W9vUf00lclhb09GGYxLJRrnveveBdyCok,714
+codelens/utils/helpers.py,sha256=xguLk0S9RFm1TcyskFYsYzeIFfTq6Km8I2EQZFyKtXY,5961
+code_analyser-0.1.0.dist-info/METADATA,sha256=TFP0d0nnJTNwM5A0QMfp9mXlTutNRm42SHyNlqWHPO4,9661
+code_analyser-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+code_analyser-0.1.0.dist-info/licenses/LICENSE,sha256=tP28nznO05HKBQN8uZ9NSvmcpzCWMj4P8e6F7IDj24Q,1070
+code_analyser-0.1.0.dist-info/RECORD,,

code_analyser-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

code_analyser-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Michael Borck
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

codelens/__init__.py

@@ -0,0 +1,7 @@
+"""
+CodeLens - Automated Code Analysis & Grading Assistant for Educators
+"""
+
+__version__ = "0.1.0"
+__author__ = "CodeLens Team"
+__description__ = "Automated Code Analysis & Grading Assistant for Educators"

codelens/__main__.py

@@ -0,0 +1,19 @@
+"""
+Entry point for running CodeLens as a module
+"""
+
+import asyncio
+import sys
+
+from codelens.cli import main
+
+if __name__ == "__main__":
+    try:
+        exit_code = asyncio.run(main())
+        sys.exit(exit_code)
+    except KeyboardInterrupt:
+        print("\nInterrupted by user", file=sys.stderr)
+        sys.exit(1)
+    except Exception as e:
+        print(f"Unexpected error: {str(e)}", file=sys.stderr)
+        sys.exit(1)

codelens/analyzers/__init__.py

@@ -0,0 +1,30 @@
+"""Code analyzers for different languages"""
+
+from .base import AnalysisIssue, AnalysisResult, BaseAnalyzer, CodeMetrics, Severity
+from .manager import AnalyzerManager, analyzer_manager
+from .python_analyzer import PythonAnalyzer
+from .similarity_analyzer import (
+    PythonSimilarityAnalyzer,
+    SimilarityDetector,
+    SimilarityMatch,
+    SimilarityMethod,
+    SimilarityResult,
+    similarity_detector,
+)
+
+__all__ = [
+    "BaseAnalyzer",
+    "AnalysisResult",
+    "AnalysisIssue",
+    "CodeMetrics",
+    "Severity",
+    "PythonAnalyzer",
+    "AnalyzerManager",
+    "analyzer_manager",
+    "SimilarityMethod",
+    "SimilarityMatch",
+    "SimilarityResult",
+    "PythonSimilarityAnalyzer",
+    "SimilarityDetector",
+    "similarity_detector",
+]

codelens/analyzers/base.py

@@ -0,0 +1,139 @@
+"""
+Base analyzer interface and common functionality
+"""
+
+import ast
+import hashlib
+from abc import ABC, abstractmethod
+from dataclasses import dataclass
+from enum import Enum
+from typing import Any
+
+
+class Severity(Enum):
+    """Issue severity levels"""
+    INFO = "info"
+    WARNING = "warning"
+    ERROR = "error"
+    CRITICAL = "critical"
+
+
+@dataclass
+class AnalysisIssue:
+    """Represents an issue found during analysis"""
+    line: int
+    column: int = 0
+    severity: Severity = Severity.WARNING
+    code: str = ""  # Error/warning code (e.g., "E501", "W292")
+    message: str = ""
+    category: str = "general"  # style, syntax, logic, complexity, etc.
+    suggestion: str | None = None  # How to fix the issue
+
+
+@dataclass
+class CodeMetrics:
+    """Code quality metrics"""
+    lines_of_code: int = 0
+    lines_of_comments: int = 0
+    blank_lines: int = 0
+    cyclomatic_complexity: int = 0
+    cognitive_complexity: int = 0
+    function_count: int = 0
+    class_count: int = 0
+    max_nesting_depth: int = 0
+    maintainability_index: float = 0.0
+
+
+@dataclass
+class AnalysisResult:
+    """Results from code analysis"""
+    success: bool
+    issues: list[AnalysisIssue]
+    metrics: CodeMetrics
+    execution_time: float = 0.0
+    analyzer_version: str = ""
+    raw_output: str | None = None  # Raw analyzer output for debugging
+
+
+class BaseAnalyzer(ABC):
+    """Base class for all code analyzers"""
+
+    def __init__(self, config: dict[str, Any] | None = None):
+        self.config = config or {}
+        self.name = self.__class__.__name__
+
+    @abstractmethod
+    async def analyze(self, code: str, file_path: str = "temp.py") -> AnalysisResult:
+        """
+        Analyze the given code and return results
+
+        Args:
+            code: Source code to analyze
+            file_path: Optional file path for context
+
+        Returns:
+            AnalysisResult with issues and metrics
+        """
+        pass
+
+    @abstractmethod
+    def get_version(self) -> str:
+        """Get the version of the analyzer tool"""
+        pass
+
+    def get_code_hash(self, code: str) -> str:
+        """Generate SHA-256 hash of code for caching/identification"""
+        return hashlib.sha256(code.encode('utf-8')).hexdigest()
+
+    def parse_ast(self, code: str) -> ast.AST | None:
+        """Parse code into AST, return None if syntax error"""
+        try:
+            return ast.parse(code)
+        except SyntaxError:
+            return None
+
+    def calculate_basic_metrics(self, code: str) -> CodeMetrics:
+        """Calculate basic code metrics from source"""
+        lines = code.split('\n')
+
+        metrics = CodeMetrics()
+        metrics.lines_of_code = len([line for line in lines if line.strip()])
+        metrics.blank_lines = len([line for line in lines if not line.strip()])
+        metrics.lines_of_comments = len([
+            line for line in lines
+            if line.strip().startswith('#') and not line.strip().startswith('#!')
+        ])
+
+        # Try to get AST metrics
+        try:
+            tree = ast.parse(code)
+            metrics.function_count = len([
+                node for node in ast.walk(tree)
+                if isinstance(node, ast.FunctionDef)
+            ])
+            metrics.class_count = len([
+                node for node in ast.walk(tree)
+                if isinstance(node, ast.ClassDef)
+            ])
+            metrics.max_nesting_depth = self._calculate_nesting_depth(tree)
+        except SyntaxError:
+            pass  # Keep default values if code doesn't parse
+
+        return metrics
+
+    def _calculate_nesting_depth(self, node: ast.AST, current_depth: int = 0) -> int:
+        """Calculate maximum nesting depth in AST"""
+        max_depth = current_depth
+
+        # Nodes that increase nesting depth
+        nesting_nodes = (ast.If, ast.While, ast.For, ast.With, ast.Try)
+
+        for child in ast.iter_child_nodes(node):
+            if isinstance(child, nesting_nodes):
+                child_depth = self._calculate_nesting_depth(child, current_depth + 1)
+                max_depth = max(max_depth, child_depth)
+            else:
+                child_depth = self._calculate_nesting_depth(child, current_depth)
+                max_depth = max(max_depth, child_depth)
+
+        return max_depth