https://github.com/project-mikoshi/ink-spotter-cli

https://github.com/project-mikoshi/ink-spotter-cli

Last synced: 10 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/project-mikoshi/ink-spotter-cli
• Owner: Project-Mikoshi
• License: mit
• Created: 2024-01-19T12:46:10.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-20T14:08:54.000Z (over 2 years ago)
• Last Synced: 2025-03-12T04:29:51.835Z (over 1 year ago)
• Language: Python
• Size: 28.3 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# InkSpotter CLI

[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)

[![openCV](https://img.shields.io/badge/openCV-4.7-5C3EE8?logo=openCV)](https://python-poetry.org/)

[![python](https://img.shields.io/badge/python-3.12-3776AB?logo=python)](https://www.python.org/downloads/release/python-3120/)

[![code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

## Overview

InkSpotter CLI is a powerful and user-friendly command-line tool designed for searching text within images. Leveraging Tesseract OCR (Optical Character Recognition), InkSpotter CLI scans a given directory for images, extracts text, and highlights instances of specified search phrases. This tool is ideal for users needing to quickly search and identify text across numerous image files.

## Features

- **Text Search in Images:** Search for any text across multiple image formats.

- **Recursive Directory Scanning:** Scans specified directory and its subdirectories for images.

- **Text Highlighting:** Highlights found text directly on the image.

- **Interactive and Command Mode:** Offers both interactive prompts and direct command mode for flexibility.

## Installation

### Prerequisites

- Python 3.12 or higher

- [Tesseract OCR](https://tesseract-ocr.github.io/tessdoc/Installation.html) installed and accessible in PATH

## Usage

### Interactive Mode

Run the script and follow the interactive prompts:

```

python inkspotter.py interactive

```

### Command Mode

Directly provide the parameters:

```

python inkspotter.py scan --search_text "Your Text" --search_directory "/path/to/directory" --output_directory "/path/to/output"

```

## License

[MIT License](LICENSE)