Merge pull request 'File and folder structure' (#1) from sturcture into main
Reviewed-on: meulilivio/AISE1_Project#1
This commit is contained in:
commit
255fc8667b
44
.gitignore
vendored
Normal file
44
.gitignore
vendored
Normal file
@ -0,0 +1,44 @@
|
||||
# Virtual Environment
|
||||
venv/
|
||||
ENV/
|
||||
env/
|
||||
.venv/
|
||||
|
||||
# Python
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
*.so
|
||||
.Python
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
wheels/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
|
||||
# IDE
|
||||
.vscode/
|
||||
.idea/
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
.DS_Store
|
||||
|
||||
# Testing
|
||||
.pytest_cache/
|
||||
.coverage
|
||||
htmlcov/
|
||||
|
||||
# Data
|
||||
data/processed/
|
||||
data/raw/
|
||||
Binary file not shown.
97
README.md
Normal file
97
README.md
Normal file
@ -0,0 +1,97 @@
|
||||
# AISE AI Code Editor
|
||||
|
||||
AI-Supported Lightweight Code Editor built with Streamlit (AISE501 Spring 2026)
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
AISE_AIAgent/
|
||||
├── frontend/ # Streamlit UI Components
|
||||
│ ├── __init__.py
|
||||
│ ├── app.py # Main Streamlit application
|
||||
│ ├── sidebar.py # File navigation sidebar
|
||||
│ ├── editor.py # Code editor pane
|
||||
│ └── chat.py # Chat interface
|
||||
│
|
||||
├── backend/ # Backend Logic Modules
|
||||
│ ├── __init__.py
|
||||
│ └── managers/ # Business logic managers
|
||||
│ ├── __init__.py
|
||||
│ ├── file_manager.py # File I/O operations
|
||||
│ ├── chat_manager.py # AI chat management
|
||||
│ ├── system_prompter.py # System prompts & context
|
||||
│ ├── search_manager.py # Internet search
|
||||
│ ├── execution_engine.py # Code execution
|
||||
│ └── debug_logger.py # Logging & debugging
|
||||
│
|
||||
├── tests/ # Unit tests
|
||||
│ ├── __init__.py
|
||||
│ ├── test_file_manager.py
|
||||
│ ├── test_chat_manager.py
|
||||
│ └── test_execution_engine.py
|
||||
│
|
||||
├── .gitignore # Git exclusions
|
||||
├── requirements.txt # Python dependencies
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- **File Display & Management**: Browse and edit code files
|
||||
- **Chat Interface**: AI-powered code assistant
|
||||
- **Code Execution**: Run Python code with debugging
|
||||
- **Internet Search**: Fetch documentation and examples
|
||||
- **System Prompts**: Context-aware AI interactions
|
||||
|
||||
## Setup
|
||||
|
||||
### 1. Activate Virtual Environment
|
||||
|
||||
```bash
|
||||
# Windows
|
||||
.\.venv\Scripts\Activate.ps1
|
||||
|
||||
# macOS/Linux
|
||||
source .venv/bin/activate
|
||||
```
|
||||
|
||||
### 2. Install Dependencies
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### 3. Run Application
|
||||
|
||||
```bash
|
||||
streamlit run frontend/app.py
|
||||
```
|
||||
|
||||
### 4. Run Tests
|
||||
|
||||
```bash
|
||||
pytest tests/
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
The application follows a frontend-backend split:
|
||||
|
||||
- **Frontend**: Streamlit UI components (sidebar, editor, chat)
|
||||
- **Backend**: Specialized manager modules
|
||||
- FileManager: File operations
|
||||
- ChatManager: AI interaction
|
||||
- SystemPrompter: Prompt management
|
||||
- SearchManager: Internet search
|
||||
- ExecutionEngine: Code execution
|
||||
- DebugLogger: Error handling & logging
|
||||
|
||||
## Development
|
||||
|
||||
Use Git to track changes:
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "Your message"
|
||||
git push origin sturcture
|
||||
```
|
||||
0
backend/__init__.py
Normal file
0
backend/__init__.py
Normal file
0
backend/managers/__init__.py
Normal file
0
backend/managers/__init__.py
Normal file
0
backend/managers/chat_manager.py
Normal file
0
backend/managers/chat_manager.py
Normal file
0
backend/managers/debug_logger.py
Normal file
0
backend/managers/debug_logger.py
Normal file
0
backend/managers/execution_engine.py
Normal file
0
backend/managers/execution_engine.py
Normal file
0
backend/managers/file_manager.py
Normal file
0
backend/managers/file_manager.py
Normal file
0
backend/managers/search_manager.py
Normal file
0
backend/managers/search_manager.py
Normal file
0
backend/managers/system_prompter.py
Normal file
0
backend/managers/system_prompter.py
Normal file
0
frontend/__init__.py
Normal file
0
frontend/__init__.py
Normal file
0
frontend/app.py
Normal file
0
frontend/app.py
Normal file
0
frontend/chat.py
Normal file
0
frontend/chat.py
Normal file
0
frontend/editor.py
Normal file
0
frontend/editor.py
Normal file
0
frontend/sidebar.py
Normal file
0
frontend/sidebar.py
Normal file
20
requirements.txt
Normal file
20
requirements.txt
Normal file
@ -0,0 +1,20 @@
|
||||
# Core Framework
|
||||
streamlit>=1.28.0
|
||||
|
||||
# AI/LLM Integration
|
||||
openai>=1.0.0
|
||||
|
||||
# Web & API
|
||||
requests>=2.31.0
|
||||
beautifulsoup4>=4.12.0
|
||||
|
||||
# Data Processing
|
||||
numpy>=1.24.0
|
||||
pandas>=2.0.0
|
||||
|
||||
# Testing
|
||||
pytest>=7.0.0
|
||||
pytest-cov>=4.0.0
|
||||
|
||||
# Development & Utilities
|
||||
python-dotenv>=1.0.0
|
||||
1
tests/__init__.py
Normal file
1
tests/__init__.py
Normal file
@ -0,0 +1 @@
|
||||
# Test Package
|
||||
0
tests/test_chat_manager.py
Normal file
0
tests/test_chat_manager.py
Normal file
0
tests/test_execution_engine.py
Normal file
0
tests/test_execution_engine.py
Normal file
0
tests/test_file_manager.py
Normal file
0
tests/test_file_manager.py
Normal file
6
tests/test_main.py
Normal file
6
tests/test_main.py
Normal file
@ -0,0 +1,6 @@
|
||||
"""Test cases for the main module."""
|
||||
|
||||
|
||||
def test_placeholder():
|
||||
"""Placeholder test."""
|
||||
assert True
|
||||
Loading…
x
Reference in New Issue
Block a user