code-analyser 0.1.0__tar.gz

code_analyser-0.1.0/.dockerignore

@@ -0,0 +1,66 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+env/
+venv/
+.venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.nox/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Project specific
+*.log
+logs/
+temp/
+uploads/
+data/
+backups/
+*.db
+*.sqlite
+*.sqlite3
+
+# Git
+.git/
+.gitignore
+
+# Docker
+.dockerignore
+Dockerfile*
+docker-compose*.yml
+
+# Documentation (keep README.md for build)
+DEPLOYMENT.md
+CODE-LENS.md
+docs/
+
+# Development
+.env.local
+.env.dev
+test_*
+tests/
+scripts/dev/

code_analyser-0.1.0/.env.example

@@ -0,0 +1,143 @@
+# CodeLens Environment Configuration Example
+# Copy this file to .env and customize for your environment
+
+# =============================================================================
+# BASIC CONFIGURATION
+# =============================================================================
+
+# Environment (development, production)
+CODELENS_ENV=development
+
+# Logging level (debug, info, warning, error)
+CODELENS_LOG_LEVEL=info
+
+# Server configuration
+CODELENS_HOST=0.0.0.0
+CODELENS_PORT=8000
+CODELENS_WORKERS=1
+
+# Application secret key (generate with: openssl rand -hex 32)
+CODELENS_SECRET_KEY=your-secret-key-here
+
+# =============================================================================
+# DATABASE CONFIGURATION
+# =============================================================================
+
+# SQLite (Development - Default)
+CODELENS_DATABASE__URL=sqlite+aiosqlite:///./codelens.db
+
+# PostgreSQL (Production - Recommended)
+# CODELENS_DATABASE__URL=postgresql+asyncpg://username:password@localhost:5432/codelens
+
+# Database connection settings
+CODELENS_DATABASE__ECHO=false
+CODELENS_DATABASE__POOL_SIZE=5
+CODELENS_DATABASE__MAX_OVERFLOW=10
+
+# =============================================================================
+# ANALYSIS CONFIGURATION
+# =============================================================================
+
+# Code analysis tools
+CODELENS_ANALYZER__RUFF_ENABLED=true
+CODELENS_ANALYZER__MYPY_ENABLED=true
+CODELENS_ANALYZER__CHECK_TYPE_HINTS=true
+CODELENS_ANALYZER__CHECK_DOCSTRINGS=true
+
+# Analysis limits
+CODELENS_ANALYZER__MAX_COMPLEXITY=10
+CODELENS_ANALYZER__MAX_LINE_LENGTH=88
+CODELENS_ANALYZER__EXECUTION_TIMEOUT=30
+CODELENS_ANALYZER__MEMORY_LIMIT=128m
+CODELENS_ANALYZER__CPU_LIMIT=0.5
+
+# =============================================================================
+# SIMILARITY DETECTION
+# =============================================================================
+
+# Enable similarity checking
+CODELENS_SIMILARITY__ENABLED=true
+CODELENS_SIMILARITY__THRESHOLD=0.8
+CODELENS_SIMILARITY__METHODS=["ast_structural", "token_based"]
+
+# AI baseline comparison
+CODELENS_SIMILARITY__USE_AI_BASELINES=false
+CODELENS_SIMILARITY__AI_BASELINE_COUNT=5
+
+# =============================================================================
+# SECURITY CONFIGURATION
+# =============================================================================
+
+# Docker integration (for code execution)
+CODELENS_DOCKER_ENABLED=true
+
+# Upload limits
+CODELENS_MAX_FILE_SIZE=10485760  # 10MB in bytes
+CODELENS_MAX_FILES_PER_BATCH=100
+
+# API rate limiting
+CODELENS_RATE_LIMIT_ENABLED=true
+CODELENS_RATE_LIMIT_REQUESTS=100
+CODELENS_RATE_LIMIT_WINDOW=3600  # 1 hour in seconds
+
+# =============================================================================
+# EXTERNAL SERVICES (Optional)
+# =============================================================================
+
+# Redis (for caching and background tasks)
+# CODELENS_REDIS_URL=redis://localhost:6379/0
+
+# Email configuration (for notifications)
+# CODELENS_EMAIL__SMTP_HOST=smtp.example.com
+# CODELENS_EMAIL__SMTP_PORT=587
+# CODELENS_EMAIL__USERNAME=your-email@example.com
+# CODELENS_EMAIL__PASSWORD=your-app-password
+# CODELENS_EMAIL__USE_TLS=true
+
+# =============================================================================
+# MONITORING AND LOGGING
+# =============================================================================
+
+# Structured logging format
+CODELENS_LOG_FORMAT=json
+
+# Health check configuration
+CODELENS_HEALTH_CHECK_TIMEOUT=30
+
+# Metrics collection
+CODELENS_METRICS_ENABLED=false
+# CODELENS_METRICS_ENDPOINT=/metrics
+
+# =============================================================================
+# DEVELOPMENT SETTINGS
+# =============================================================================
+
+# Auto-reload on file changes (development only)
+CODELENS_AUTO_RELOAD=false
+
+# API documentation (always enabled for educational tool)
+CODELENS_DOCS_ENABLED=true
+
+# Debug mode
+CODELENS_DEBUG=false
+
+# =============================================================================
+# PRODUCTION OVERRIDES
+# =============================================================================
+
+# For production deployment, uncomment and configure:
+
+# Database (PostgreSQL recommended for production)
+# CODELENS_DATABASE__URL=postgresql+asyncpg://codelens:secure_password@localhost:5432/codelens
+
+# Performance
+# CODELENS_WORKERS=4
+# CODELENS_LOG_LEVEL=warning
+
+# Security
+# CODELENS_SECRET_KEY=your-super-secure-secret-key-generated-randomly
+# CODELENS_RATE_LIMIT_ENABLED=true
+# CODELENS_DOCS_ENABLED=true  # Keep enabled for educational tool
+
+# Caching
+# CODELENS_REDIS_URL=redis://localhost:6379/0

code_analyser-0.1.0/CODE-LENS.md

@@ -0,0 +1,223 @@
+# CodeLens - Code Analysis Microservice
+
+**Automated Code Analysis & Grading Assistant for Educators**
+
+## 🎯 Vision
+
+A dedicated microservice for analyzing, validating, and grading student code submissions across multiple programming languages. Designed to help educators provide consistent, comprehensive feedback while reducing manual grading time. Designed for introductor programming courses where a complete development stak, like linters, typecheckers etc may not have been setup.
+
+## 🚀 Core Purpose
+
+Unlike DocumentLens (focused on natural language and academic text), CodeLens specializes in:
+- Static code analysis and quality metrics
+- Syntax validation and error detection
+- Code similarity/plagiarism detection
+- Automated test execution
+- Grading rubric application
+- Constructive feedback generation
+
+## 📊 Target Languages (MVP)
+
+1. **Python** - Full AST analysis, complexity metrics, PEP8 compliance
+2. **HTML** - W3C validation, accessibility checks, semantic structure
+3. **CSS** - Validation, best practices, browser compatibility
+4. **JavaScript** - Syntax validation, ESLint rules, common pitfalls
+
+## 🏗️ Proposed Architecture
+
+```
+codelens/
+├── app/
+│   ├── analyzers/
+│   │   ├── python_analyzer.py      # AST parsing, complexity, style
+│   │   ├── html_analyzer.py        # Structure, validation, accessibility
+│   │   ├── css_analyzer.py         # Validation, best practices
+│   │   ├── js_analyzer.py          # Syntax, linting, patterns
+│   │   └── similarity_checker.py   # Cross-submission similarity
+│   │
+│   ├── services/
+│   │   ├── code_executor.py        # Safe code execution sandbox
+│   │   ├── test_runner.py          # Run unit tests
+│   │   ├── w3c_validator.py        # W3C API integration
+│   │   ├── feedback_generator.py   # AI-assisted feedback
+│   │   └── rubric_evaluator.py     # Apply grading rubrics
+│   │
+│   ├── validators/
+│   │   ├── syntax_validator.py     # Language-specific syntax checks
+│   │   ├── security_scanner.py     # Security vulnerability detection
+│   │   └── best_practices.py       # Coding standards enforcement
+│   │
+│   └── api/
+│       └── routes/
+│           ├── analyze.py          # Single file analysis
+│           ├── batch.py            # Batch submission processing
+│           ├── rubric.py           # Rubric management
+│           └── reports.py          # Grade report generation
+```
+
+## 🔧 Key Features
+
+### 1. Code Quality Analysis
+- **Complexity Metrics**: Cyclomatic complexity, nesting depth, LOC
+- **Style Compliance**: PEP8 (Python), ESLint (JS), W3C (HTML/CSS)
+- **Code Smells**: Duplicate code, long methods, unused variables
+- **Documentation**: Docstring coverage, comment quality
+
+### 2. Correctness Validation
+- **Syntax Checking**: Language-specific parsers
+- **Type Checking**: Static type analysis where applicable
+- **Logic Errors**: Common mistakes and anti-patterns
+- **Output Validation**: Expected vs actual output comparison
+
+### 3. Plagiarism Detection
+- **Structural Similarity**: AST-based comparison
+- **Token Analysis**: Variable renaming detection
+- **Cross-Cohort**: Compare across student submissions
+- **External Sources**: Check against online repositories
+
+### 4. Educational Feedback
+- **Constructive Comments**: Explain what's wrong and why
+- **Improvement Suggestions**: How to fix issues
+- **Learning Resources**: Links to relevant documentation
+- **Progress Tracking**: Performance over time
+
+## 📡 API Design
+
+### Core Endpoints
+
+```
+POST /api/analyze/python
+POST /api/analyze/web       # HTML/CSS/JS bundle
+POST /api/analyze/batch      # Multiple submissions
+
+GET  /api/rubrics           # Available grading rubrics
+POST /api/rubrics           # Create custom rubric
+
+POST /api/compare           # Similarity checking
+GET  /api/reports/{id}      # Detailed analysis report
+```
+
+### Example Request/Response
+
+```json
+// Request
+{
+  "code": "def calculate_grade(score):\n    return score * 100",
+  "language": "python",
+  "rubric_id": "intro-python-assignment-1",
+  "check_similarity": true,
+  "cohort_id": "CS101-2024"
+}
+
+// Response
+{
+  "analysis": {
+    "syntax": {
+      "valid": true,
+      "errors": []
+    },
+    "quality": {
+      "complexity": 1,
+      "style_issues": [
+        {
+          "line": 1,
+          "issue": "Missing function docstring",
+          "severity": "minor"
+        }
+      ]
+    },
+    "correctness": {
+      "test_results": "3/5 passed",
+      "logic_issues": ["No input validation"]
+    },
+    "similarity": {
+      "highest_match": 0.15,
+      "flagged": false
+    }
+  },
+  "grade": {
+    "score": 75,
+    "breakdown": {
+      "functionality": 30,
+      "style": 15,
+      "documentation": 10,
+      "testing": 20
+    }
+  },
+  "feedback": {
+    "strengths": ["Clean function structure"],
+    "improvements": ["Add input validation", "Include docstring"],
+    "resources": ["https://peps.python.org/pep-0257/"]
+  }
+}
+```
+
+## 🛠️ Technology Stack
+
+### Core Dependencies
+- **Python Analysis** (configurable options): `ast`, `pylint`, `mypy`, `black`, `radon`, `ruff`, `basedpyright`
+- **Web Validation**: `html5lib`, `cssutils`, `beautifulsoup4`
+- **JavaScript**: `esprima` (via subprocess), `jshint`
+- **Similarity**: `difflib`, `python-Levenshtein`, custom AST comparison
+- **Sandboxing**: `docker` or `firejail` for safe execution
+
+### External Services
+- **W3C Validator**: Optional for official HTML/CSS validation
+- **GitHub API**: Check against public repositories
+- **OpenAI API**: Optional for enhanced feedback generation
+
+## 🚦 Implementation Phases
+
+### Phase 1: Python Analysis (Week 1-2)
+- AST-based analysis
+- Style checking (PEP8)
+- Basic complexity metrics
+- Simple test runner
+
+### Phase 2: Web Technologies (Week 3-4)
+- HTML structure validation
+- CSS validation
+- JavaScript syntax checking
+- Basic accessibility checks
+
+### Phase 3: Similarity Detection (Week 5)
+- Token-based comparison
+- AST structural similarity
+- Cohort-wide checking
+
+### Phase 4: Grading & Feedback (Week 6)
+- Rubric system
+- Automated scoring
+- Feedback generation
+- Report creation
+
+## 🔒 Security Considerations
+
+1. **Code Execution Sandbox**: Never execute student code directly
+2. **Resource Limits**: CPU, memory, and time constraints
+3. **Input Sanitization**: Prevent injection attacks
+4. **Access Control**: Educator-only endpoints
+5. **Data Privacy**: Secure storage of student submissions
+
+## 📈 Future Enhancements
+
+- **More Languages**: Java, C++, SQL, R
+- **IDE Integration**: VS Code extension
+- **Real-time Analysis**: Live coding feedback
+- **Peer Review**: Student cross-evaluation
+- **Learning Analytics**: Track common mistakes
+- **AI Tutoring**: Personalized learning paths
+
+## 🎓 Educational Impact
+
+CodeLens aims to:
+- Provide consistent, objective grading
+- Reduce educator workload
+- Give students immediate feedback
+- Identify struggling students early
+- Track learning progress over time
+- Encourage best practices from the start
+
+---
+
+*CodeLens: Empowering educators with intelligent code analysis*