How rezonaldo/format-check-paper works
IEEE Manuscript Format Checker accepts a PDF through a Streamlit web interface, a batch CLI, or a FastAPI endpoint. Each entry point checks file safety and manuscript eligibility before the IEEE rules engine evaluates formatting and produces violations and metadata. The results feed PDF annotations and Word/Excel review sheets; the API also returns structured violation data. The graph separates those stages and the shared result model. Source excerpts show the entry-point calls and shared modules; the README documents the product workflow and supported checks, but unsampled UI/API wiring is not inferred.
Main entry points: app.py Web Checker · cli.py Batch CLI · index.py HTTP API · rules.py IEEE Rules Engine
Components 13
Submission Interfaces
- Web Checker
app.py - Batch CLI
cli.py - HTTP API
api/index.py
Document Gates
- PDF Safety
core/validator.py - Manuscript Gate
core/validator.py
Compliance Inspection
- IEEE Rules Engine
core/rules.py
Review Outputs
- PDF Annotator
core/highlighter.py - Word Review Sheet
core/report_generator.py - Excel Review Sheet
core/report_generator.py - Structured API Result
api/index.py
Shared Data
- Violation Records
core/models.py - Paper Metadata
core/models.py
Other components
- Paper Reviewer
Connections 28
- Paper Reviewer → Web Checker: uploads PDF
README.md - Paper Reviewer → Batch CLI: submits PDF
README.md - Paper Reviewer → HTTP API: submits PDF
- Web Checker → PDF Safety: validates safety
app.py - Web Checker → Manuscript Gate: checks eligibility
app.py - Web Checker → IEEE Rules Engine: checks compliance
app.py - Web Checker → PDF Annotator: annotates PDF
app.py - Web Checker → Word Review Sheet: generates report
app.py - Web Checker → Excel Review Sheet: generates report
app.py - Batch CLI → PDF Safety: validates safety
cli.py - Batch CLI → Manuscript Gate: checks eligibility
cli.py - Batch CLI → IEEE Rules Engine: checks compliance
cli.py - Batch CLI → PDF Annotator: annotates PDF
cli.py - Batch CLI → Word Review Sheet: generates report
cli.py - Batch CLI → Excel Review Sheet: generates report
cli.py - HTTP API → PDF Safety: validates safety
api/index.py - HTTP API → Manuscript Gate: checks eligibility
api/index.py - HTTP API → IEEE Rules Engine: checks compliance
api/index.py - HTTP API → PDF Annotator: annotates PDF
api/index.py - HTTP API → Word Review Sheet: generates report
api/index.py - HTTP API → Structured API Result: returns findings
api/index.py - IEEE Rules Engine → Violation Records: creates records
core/rules.py - IEEE Rules Engine → Paper Metadata: returns metadata
core/rules.py - PDF Annotator → Violation Records: reads findings
core/highlighter.py - Word Review Sheet → Violation Records: formats findings
core/report_generator.py - Word Review Sheet → Paper Metadata: formats metadata
core/report_generator.py - Excel Review Sheet → Violation Records: formats findings
core/report_generator.py - Excel Review Sheet → Paper Metadata: formats metadata
core/report_generator.py