Skip to content

Commit ef05108

Browse files
committed
Refactor and rename application components for improved clarity and functionality
- Updated the main application entry point to reflect the new `ragadoc` package name, enhancing clarity in the codebase. - Refactored the document upload and processing logic to integrate with the new RAG system, ensuring seamless user experience. - Renamed environment and configuration files to align with the new package structure. - Enhanced development instructions to clarify project setup and usage guidelines. - Introduced new modules for chat management, LLM interface, and UI components, improving code organization and maintainability. - Updated tests to reflect changes in module imports and ensure continued functionality.
1 parent 4652cdd commit ef05108

23 files changed

+74
-53
lines changed

DEVELOPMENT_INSTRUCTIONS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@
55
- Debug information belongs into the command line logs, not in the app UI/UX.
66
- Always develop a generic solution, do not use content from specific examples in the code
77
- Never include content from example documents in the source code. Never leak content from provided examples into test code!
8-
- If you create new .py files for testing or debugging, place them in the experiments folder. Delete them after they are no longer useful. If they yield meaningful unit tests, integrate them into the test suite.
8+
- If you create new .py files for testing or debugging, place them in the experiments folder. Delete them after they are no longer useful. If they yield meaningful unit tests, integrate them into the test suite.
9+
- Do not put implementation details into the README. The README serves as a compact user manual for getting started.

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Ragnarok - Enhanced PDF Processing
1+
# Ragadoc - Enhanced PDF Processing
22

33
A powerful PDF processing system with high-quality text extraction and structure preservation, optimized for LLM/RAG applications.
44

@@ -42,7 +42,7 @@ pip install -r requirements.txt
4242
2. **Or use Conda**:
4343
```bash
4444
conda env create -f environment.yml
45-
conda activate ragnarok
45+
conda activate ragadoc
4646
```
4747

4848
3. **Install Ollama Models for RAG**:
@@ -76,7 +76,7 @@ Then:
7676
### RAG System (Programmatic)
7777

7878
```python
79-
from ragnarok import create_rag_system
79+
from ragadoc import create_rag_system
8080

8181
# Create RAG system
8282
rag = create_rag_system(
@@ -91,7 +91,7 @@ with open('document.pdf', 'rb') as f:
9191
pdf_bytes = f.read()
9292

9393
# Extract text and process with RAG
94-
from ragnarok import EnhancedPDFProcessor
94+
from ragadoc import EnhancedPDFProcessor
9595
processor = EnhancedPDFProcessor(pdf_bytes)
9696
text = processor.extract_full_text()
9797

@@ -107,7 +107,7 @@ print(result['response'])
107107
### Basic PDF Processing
108108

109109
```python
110-
from ragnarok.enhanced_pdf_processor import EnhancedPDFProcessor
110+
from ragadoc.enhanced_pdf_processor import EnhancedPDFProcessor
111111

112112
# Load PDF
113113
with open('document.pdf', 'rb') as f:

app.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
"""
2-
Refactored Streamlit App for Document Q&A
2+
Streamlit application that provides a web interface for enhanced PDF processing
3+
from the ragadoc package.
34
45
This is now a much simpler main entry point that uses the UI modules
56
from the ragnarok package.
67
"""
78

89
import streamlit as st
9-
from ragnarok import (
10+
from ragadoc import (
1011
setup_streamlit_config,
1112
init_session_state,
1213
render_sidebar,

docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ services:
44
# Streamlit application
55
app:
66
build: .
7-
container_name: ragnarok-app
7+
container_name: ragadoc-app
88
ports:
99
- "8501:8501"
1010
environment:

environment.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: ragnarok
1+
name: ragadoc
22
channels:
33
- defaults
44
- conda-forge

ragnarok/__init__.py renamed to ragadoc/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Ragnarok - AI-powered PDF processing and highlighting system with RAG capabilities
2+
Ragadoc - AI-powered PDF processing and highlighting system with RAG capabilities
33
"""
44

55
from .enhanced_pdf_processor import (
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)