Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/pdf support #23

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

rickyharvywaldt
Copy link

@rickyharvywaldt rickyharvywaldt commented Jan 24, 2025

Summary by CodeRabbit

  • New Features

    • Added support for PDF file processing and conversion to images
    • Enhanced OCR functionality to extract and validate total amounts
    • Improved text extraction with more robust amount parsing
  • Dependencies

    • Added Streamlit for web application interface
    • Added Ollama for OCR processing
    • Added PyMuPDF for PDF handling
  • Chores

    • Updated .gitignore to exclude .env files

Copy link

coderabbitai bot commented Jan 24, 2025

Walkthrough

The pull request introduces enhancements to a document OCR application, focusing on PDF file support and improved amount extraction. The changes include adding PDF processing capabilities, implementing a new amount extraction function, and updating the application to handle PDF files alongside images. New dependencies are added to support these features, and environment configuration files are updated to protect sensitive information.

Changes

File Changes
.gitignore Added .env to prevent environment files from being tracked
app.py - Added PDF to image conversion function
- Implemented amount extraction function
- Enhanced file upload to support PDFs
- Modified OCR text extraction logic
requirements.txt Added new dependencies: streamlit, ollama, pymupdf

Sequence Diagram

sequenceDiagram
    participant User
    participant Streamlit
    participant PDFConverter
    participant OCRModel
    participant AmountExtractor

    User->>Streamlit: Upload PDF/Image
    Streamlit->>PDFConverter: Convert PDF to Image
    PDFConverter-->>Streamlit: Image Bytes
    Streamlit->>OCRModel: Send Image for Text Extraction
    OCRModel-->>Streamlit: Extracted Text
    Streamlit->>AmountExtractor: Clean and Validate Amount
    AmountExtractor-->>Streamlit: Processed Amount
    Streamlit->>User: Display Extraction Results
Loading

Poem

🐰 A rabbit's tale of bytes and files,
PDF dancing through OCR's smiles,
Amounts extracted, clean and bright,
Streamlit's magic, a coder's delight!
.env hidden, secrets kept tight 🕵️‍♀️

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (4)
llama-ocr/app.py (4)

30-50: Consider broader locale handling or specialized currency parsing.
The extract_amount function removes all non-numeric characters, handles multiple decimal points, and returns a float. This approach is straightforward but may fail for certain locale formats (e.g., negative amounts or parentheses, currency symbols like '€', or multiple decimal separators). If you plan to support more complex currency formats, consider a specialized library (e.g., Babel) or handle negative values and locale-specific separators.


51-60: Note that only the first page of the PDF is converted.
Currently, pdf_to_image processes only the first page. If multi-page PDF support is needed in the future, consider looping over pages and combining or selecting the desired page(s).

Do you want a snippet showing how to handle multiple pages automatically?


71-79: Catching and displaying PDF conversion errors.
Using a try-except block for PDF conversion is a good approach to handle malformed or encrypted PDFs. Consider logging errors for debugging to track repeated conversion failures.


92-114: Add error checks for unexpected model output.
The call to ollama.chat uses a prompt expecting a single numeric amount. If the model returns text that doesn't contain a clear amount, the extraction logic may fail. Handling unexpected format or empty results would improve reliability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c0555f2 and fd38fbd.

📒 Files selected for processing (3)
  • llama-ocr/.gitignore (1 hunks)
  • llama-ocr/app.py (3 hunks)
  • llama-ocr/requirements.txt (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • llama-ocr/.gitignore
  • llama-ocr/requirements.txt
🔇 Additional comments (7)
llama-ocr/app.py (7)

20-20: UI layout approach looks fine.
Defining two columns with different widths is a neat approach to place the clear button. Make sure col1 is utilized for any additional content if needed.


61-69: Good user interface for file upload.
Users can upload either images or PDFs, which is flexible. You might want to limit maximum file size or handle extremely large PDFs to prevent performance issues.


80-83: Direct image loading looks solid.
Loading images with PIL is straightforward. You might eventually want to check or warn if the image is very large to help control memory usage.


84-88: Streamlined conversion to PNG bytes.
Converting the image to PNG ensures a consistent format for OCR. In some scenarios, preserving the original format may be necessary (e.g., to maintain higher fidelity). For now, this is fine.


120-120: Clear presentation of extracted result.
Displaying the extracted amount from session state is clear and straightforward. Good job!


126-126: Footer branding looks neat.
Providing a direct link to report issues is helpful for users to submit bug reports and feedback.


5-6: Validate library versions and security patches.
Adding PyMuPDF (fitz) and re is appropriate for PDF processing and regex-based text cleaning. To ensure security and stability, consider verifying that you are using the latest releases of PyMuPDF and that no high-severity vulnerabilities exist in it.

Below is a script you can run to search for advisories on PyMuPDF:

✅ Verification successful

PyMuPDF and re libraries are secure and up-to-date
PyMuPDF is at the latest version (1.25.2) with no known security vulnerabilities reported in GitHub's advisory database. The re module is a built-in Python library that's maintained as part of Python's standard library.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for known PyMuPDF vulnerabilities
curl -s https://pypi.org/pypi/PyMuPDF/json | jq '.info.version'
gh api graphql -f query='
{
  securityVulnerabilities(first: 5, ecosystem: PIP, package: "pymupdf") {
    nodes {
      advisory {
        summary
        severity
        publishedAt
      }
      vulnerableVersionRange
      firstPatchedVersion {
        identifier
      }
    }
  }
}'

Length of output: 413

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant