Skip to main content

CLI and GUI launcher for the Mirumoji project, an open-source, self-hostable Japanese language immersion tool.

Project description

Overview

Mirumoji is an open-source, self-hosted Japanese immersion toolkit. Drop in any video, anime episode, drama or audio clip and it gives you: clickable tokenized subtitles with dictionary pop-ups, Whisper-powered transcription, instant SRT/clip extraction, and one-click Anki deck export — all in Docker, all running on your own machine.

Optional OpenAI Integration - Customizable GPT Breakdowns of Subtitles -

Optional Modal Integration - Install a CPU only version and run all GPU tasks on the cloud -


Preview

You can see a preview of the application's frontend (No backend running) Here

Features

Interactive Video Player

alt-text

Upload your local anime/J-Drama espisodes or any Japanese video and .SRT subtitles.

Clickable Japanese Subtitles

alt-text

Subtitles are tokenized (kuromoji.js), allowing you to click individual words with integrated offline JMDict for definitions.

OpenAI Integration

alt-text

Modify System Message and User Prompt with {sentence} and {word} variables.

Local Media Processing

Video Conversion

Upload videos in various formats; they can be converted to MP4 for optimal playback.

SRT Generation

Generate subtitles for your videos. Runs FasterWhisper with modified parameters to increase accuracy for longer media such as Anime/ J-Drama episodes.

Audio Transcription

alt-text

Transcribe Japanese audio from recordings or uploaded files.

Profile-Based Data Management:

Persistent Storage

alt-img

Profile configurations and all other profile-related data is stored and managed via SQLite database by the backend.

Clip Saving

alt-img

Save important video segments with their associated word breakdowns and export as an Anki Deck


Setup

Both the frontend and backend have pre-built Docker images and are set up to work with Docker Compose.

The easiest setup is to run the launcher for your platform. For detailed instructions please refer to the Setup Guide

You can also choose to build the images locally with the Dockerfiles provided.


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

mirumoji-2.3.4.tar.gz (19.5 kB view details)

Uploaded Source

Built Distribution

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

mirumoji-2.3.4-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file mirumoji-2.3.4.tar.gz.

File metadata

  • Download URL: mirumoji-2.3.4.tar.gz
  • Upload date:
  • Size: 19.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mirumoji-2.3.4.tar.gz
Algorithm Hash digest
SHA256 143645c659c95d3b19b0d7ddccf7f6b37b518395223e4a74bb7508095658698c
MD5 d957b26ced46d9c1e6e054836bc89f97
BLAKE2b-256 eec0aa9f2fd04b364dc4f8bda782929f05501a05e2022bf3c09f8d0f66990321

See more details on using hashes here.

Provenance

The following attestation bundles were made for mirumoji-2.3.4.tar.gz:

Publisher: cli-pypi_release.yaml on svdC1/mirumoji

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

File details

Details for the file mirumoji-2.3.4-py3-none-any.whl.

File metadata

  • Download URL: mirumoji-2.3.4-py3-none-any.whl
  • Upload date:
  • Size: 21.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mirumoji-2.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 fa5b77290c624d7c017ba0c624fbef90e21a12e2b57b095c57adb187fc0ee9ac
MD5 26c80b8f6ed0ebc3d85122c4cf609058
BLAKE2b-256 0aff764db5bf04868abf60a015884305d66feceaceb2cc716c5808ead6e76b79

See more details on using hashes here.

Provenance

The following attestation bundles were made for mirumoji-2.3.4-py3-none-any.whl:

Publisher: cli-pypi_release.yaml on svdC1/mirumoji

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