https://github.com/blueaxis/Cloe

Manga OCR snipping application for desktop
https://github.com/blueaxis/Cloe

manga-ocr ocr ocr-python pyqt5 snipping-tool

Last synced: about 2 months ago
JSON representation

Manga OCR snipping application for desktop

• Host: GitHub
• URL: https://github.com/blueaxis/Cloe
• Owner: blueaxis
• License: other
• Created: 2022-04-24T06:35:49.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-07T11:32:44.000Z (almost 2 years ago)
• Last Synced: 2024-07-31T20:29:56.743Z (4 months ago)
• Topics: manga-ocr, ocr, ocr-python, pyqt5, snipping-tool
• Language: Python
• Homepage:
• Size: 2.26 MB
• Stars: 89
• Watchers: 2
• Forks: 8
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-immersion - Cloe - reader. (Browser-based / Paid and proprietary)

README

        


  

    

  



Cloe


 Snipping utility for the MangaOCR model 


## Contents

- [About](#about)

- [User Guide](#user_guide)

- [Acknowledgments](#acknowledgements)

## About 

Inspired by [Capture2Text](http://capture2text.sourceforge.net/), Cloe is a snipping tool for the [Manga OCR library](https://pypi.org/project/manga-ocr/). The project works similarly to Capture2Text but uses the MangaOCR model instead. See demo below to see how it works.

https://user-images.githubusercontent.com/45705751/166183555-ef11bf64-9cea-4c04-8a71-2293065d644c.mp4

## User Guide  

Launch the application and wait for the model to load. Show the snipping window using shortcut `Alt+Q` and drag and hold the mouse cursor to start performing OCR.

### Installation 

Download the latest zip file [here](https://github.com/bluaxees/Cloe/releases/latest/). Decompress the file in the desired directory. Make sure that the `app` folder is in the same folder as the shortcut `Cloe`.

### System Requirements

Recommended:

- Hard drive: at least 700 MB HD space

- RAM: at least 2 GB (recommended)

### Development Setup

 - Install [poetry](https://python-poetry.org/docs/#installation) on a supported Python version (3.8, 3.9).

 - Clone this repo and install dependencies by running: `poetry install --with dev`.

 - In the `app` directory, use `python main.py` to run the app.

 - If you want to build the app locally, run `pyinstaller main.spec` in the `build` directory.

## Acknowledgements 

This project will not be possible without the MangaOCR model by [Maciej Budyś](https://github.com/kha-white).

The software is licensed under GPLv3 (see [LICENSE](LICENSE.md)) and uses third party libraries that are distributed under their own terms (see [LICENSE-3RD-PARTY](LICENSE-3RD-PARTY.md)).

The icons used in this project are from [Icons8](https://icons8.com).