Module: Tahweel

Defined in:
lib/tahweel.rb,
lib/tahweel/ocr.rb,
lib/tahweel/writer.rb,
lib/tahweel/version.rb,
lib/tahweel/converter.rb,
lib/tahweel/authorizer.rb,
lib/tahweel/cli/options.rb,
lib/tahweel/writers/txt.rb,
lib/tahweel/pdf_splitter.rb,
lib/tahweel/writers/docx.rb,
lib/tahweel/writers/json.rb,
lib/tahweel/poppler_installer.rb,
lib/tahweel/cli/file_collector.rb,
lib/tahweel/cli/file_processor.rb,
lib/tahweel/cli/progress_renderer.rb,
lib/tahweel/processors/google_drive.rb

Overview

rubocop:disable Style/Documentation

Defined Under Namespace

Modules: CLI, Processors, Writers Classes: Authorizer, Converter, Error, Ocr, PdfSplitter, PopplerInstaller, Writer

Constant Summary collapse

VERSION = 
"0.1.6"

Class Method Summary collapse

Class Method Details

.convert(pdf_path, dpi: PdfSplitter::DEFAULT_DPI, processor: :google_drive, concurrency: Converter::DEFAULT_CONCURRENCY) ⇒ Array<String>

Converts a PDF file to text by splitting it into images and running OCR on each page.

Parameters:

  • pdf_path (String) —

    Path to the PDF file.

  • dpi (Integer) (defaults to: PdfSplitter::DEFAULT_DPI) —

    DPI for PDF to image conversion (default: 150).

  • processor (Symbol) (defaults to: :google_drive) —

    OCR processor to use (default: :google_drive).

  • concurrency (Integer) (defaults to: Converter::DEFAULT_CONCURRENCY) —

    Max concurrent OCR operations (default: 12).

Returns:

  • (Array<String>) —

    An array containing the text of each page.



28
29
30
31
32
 
# File 'lib/tahweel.rb', line 28

def self.convert(pdf_path, dpi: PdfSplitter::DEFAULT_DPI, processor: :google_drive,
                 concurrency: Converter::DEFAULT_CONCURRENCY, &)
  Converter.convert(pdf_path,
                    dpi:, processor:, concurrency:, &)
end

.extract(image_path, processor: :google_drive) ⇒ String

Extracts text from an image file using the specified OCR processor.

Parameters:

  • image_path (String) —

    Path to the image file.

  • processor (Symbol) (defaults to: :google_drive) —

    OCR processor to use (default: :google_drive).

Returns:

  • (String) —

    The extracted text.



39
 
# File 'lib/tahweel.rb', line 39

def self.extract(image_path, processor: :google_drive) = Ocr.extract(image_path, processor:)