Skip to main content

OCR snipping tool for reading manga.

Project description

Project logo

OCR application for reading manga in Japanese, made for AJATTers🇯🇵

Lancet

PyPi Chat Support

Lancet is an OCR application for reading manga in Japanese. It uses PyTorch models to recognize Japanese text in images. Lancet works best with Goldendict-ng or Rikaitan.

https://github.com/user-attachments/assets/8859adac-1bd8-435a-9c81-945f875dc205

User Guide

Prerequisites:

  • Goldendict for looking up words in Japanese dictionaries.
  • nsxiv for reading manga.

Launch Goldendict, then open a manga folder in nsxiv. Start Lancet and wait for the OCR model to load. Press the OCR shortcut (default Alt+O) to show the snipping window, then drag and hold the mouse to perform OCR.

Lancet adds an icon to the system tray. Right‑click the icon to access actions, including Preferences, where you can change the OCR shortcut.

Installation

Install via pipx from pypi.

pipx install ajt-lancet

The lancet executable will be available in your $PATH.

[!NOTE] On Windows-like systems, you may need to add the folder containing the lancet executable to your $PATH manually.

[!NOTE] If you don't have the required python version, install it first with hatch.

hatch python install 3.13
pipx install ajt-lancet --python ~/.local/share/hatch/pythons/3.13/python/bin/python

System Requirements

Lancet depends on large Python libraries. pipx installs everything in an isolated location (~/.local/share/pipx) so you can cleanly uninstall with pipx uninstall later. The PyTorch models are downloaded from HuggingFace and saved to ~/.cache/huggingface.

  • Disk space: ~8 GiB (PyTorch and dependencies)
  • RAM: at least 2 GiB

Wayland support

Wayland support has been tested on Sway 1.11. Wayland support is incomplete. It works best on Hyprland and Sway, but on other compositors you may face issues if you have multiple monitors. 🙏 Please suggest improvements via pull requests on GitHub.

Upgrading

Running pipx upgrade upgrades lancet to the latest version.

pipx upgrade ajt-lancet

Running pipx upgrade-all upgrades all packages installed with pipx.

pipx upgrade-all

Development Setup

Since Ajatt-Tools is a distributed effort, we highly welcome new contributors! Install the project in development mode to easily test and commit your changes using hatch.

  • Clone the repo.

  • Install hatch:

    pipx install hatch
    pipx upgrade hatch
    
  • CD into the repo and run:

    hatch shell
    
  • Inside the hatch shell run:

    pip install -e .
    
  • To run the app, run:

    hatch run lancet
    

Try these libre code editors with python support:

Autostart

Add the lancet command to your autostart so Lancet launches at login.

Here's an example for i3wm:

exec --no-startup-id lancet

Announcements

  1. Sunsetting Transformers OCR
  2. Meet Lancet

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ajt_lancet-26.3.20.0.tar.gz (633.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ajt_lancet-26.3.20.0-py3-none-any.whl (638.1 kB view details)

Uploaded Python 3

File details

Details for the file ajt_lancet-26.3.20.0.tar.gz.

File metadata

  • Download URL: ajt_lancet-26.3.20.0.tar.gz
  • Upload date:
  • Size: 633.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ajt_lancet-26.3.20.0.tar.gz
Algorithm Hash digest
SHA256 ccb86359d56d795d1c4780a81bb78932662038d9faad9f0bee39c62dd8998b3b
MD5 f0c194ecd608e0cc62919f3a61ef3bc2
BLAKE2b-256 6aee1526d5855e3eb3826c393ffa7d4d2ac617585dcb7c858fd0da2ed784a8fe

See more details on using hashes here.

Provenance

The following attestation bundles were made for ajt_lancet-26.3.20.0.tar.gz:

Publisher: release.yml on Ajatt-Tools/lancet

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ajt_lancet-26.3.20.0-py3-none-any.whl.

File metadata

  • Download URL: ajt_lancet-26.3.20.0-py3-none-any.whl
  • Upload date:
  • Size: 638.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ajt_lancet-26.3.20.0-py3-none-any.whl
Algorithm Hash digest
SHA256 89280abd36fc11f935da8b03097a2cf30117786525fbb4bd23ed578589ecb419
MD5 9185480a05af99b6bec1affdf89641e8
BLAKE2b-256 61dad7f244d784997aef831be984f6c7fa24cb95304965459c242fc152da1d17

See more details on using hashes here.

Provenance

The following attestation bundles were made for ajt_lancet-26.3.20.0-py3-none-any.whl:

Publisher: release.yml on Ajatt-Tools/lancet

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page