Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Document Review System

A Streamlit-based web application for reviewing and managing document batches stored in AWS S3. Track document versions, compare batches, and maintain audit trails of all review decisions.

Features

  • Batch Management: Organize documents into logical batches (CI, PL document types)
  • Version Comparison: Side-by-side comparison of different document versions
  • S3 Integration: Seamlessly upload and retrieve documents from AWS S3
  • Review Status Tracking: Track portal status, decisions, and review reasons
  • Audit Trail Export: Export complete review history with timestamps and decisions
  • Responsive UI: Custom CSS styling optimized for document review workflows

Tech Stack

  • Frontend: Streamlit
  • Data Processing: Pandas
  • Cloud Storage: AWS S3 (boto3)
  • Testing: pytest
  • Python 3.8+

Setup

Prerequisites

  • Python 3.8 or higher
  • AWS credentials configured (access key, secret key, region)
  • Streamlit secrets file configured

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/document-review-panel.git
cd document-review-panel
  1. Create a virtual environment:
python3 -m venv venv
source venv/bin/activate
  1. Install dependencies:
pip install -r requirements.txt
  1. Configure AWS credentials in .streamlit/secrets.toml:
[aws]
access_key_id = "your-access-key"
secret_access_key = "your-secret-key"
region = "eu-central-1"
bucket_name = "your-bucket"
base_prefix = "Doc_Review/"
  1. Run the application:
streamlit run src/app.py

Usage

  1. Select a Batch: Choose from available batches in the sidebar
  2. Choose Document Type: Select between CI or PL document types
  3. Select Version: Pick the version you want to review
  4. Review Decision: Mark as Accept/Reject with optional notes
  5. Compare Versions: View side-by-side comparisons when multiple versions exist
  6. Export Results: Download audit trail of all review decisions

Project Structure

src/
├── app.py              # Main Streamlit application
├── utils.py            # Utility functions (data loading, formatting, audit trails)
├── s3_utils.py         # AWS S3 integration
└── styles.py           # CSS styling
scripts/
└── upload_to_s3.py     # Document migration script
data/
└── Manual_Review.csv   # Batch review metadata
tests/
└── test_utils.py       # Unit tests

Running Tests

pytest tests/

Development

To run the migration script for uploading documents to S3:

python scripts/upload_to_s3.py

License

MIT

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages