https://github.com/itsupera/furiganalyse
Add furigana to Japanese ebooks (and other useful conversions)
https://github.com/itsupera/furiganalyse
epub furigana japanese japanese-language python
Last synced: 4 months ago
JSON representation
Add furigana to Japanese ebooks (and other useful conversions)
- Host: GitHub
- URL: https://github.com/itsupera/furiganalyse
- Owner: itsupera
- License: mit
- Created: 2021-06-20T16:21:47.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2026-01-29T20:48:19.000Z (5 months ago)
- Last Synced: 2026-01-30T08:53:20.737Z (5 months ago)
- Topics: epub, furigana, japanese, japanese-language, python
- Language: Python
- Homepage: http://furiganalyse.itsupera.co/
- Size: 500 KB
- Stars: 77
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Furiganalyse
=============
Annotate Japanese ebooks with furigana, and other conversions.
---
Supported input formats:
- EPUB
- AZW3 (without DRM)
- MOBI
Supported output formats:
- EPUB
- AZW3 (without DRM)
- MOBI
- Many text files (one per book part)
- Single text file
- Anki Deck (each sentence as a card)
- HTML (readable in web browser)
Setup and run
--------------
Using Docker to create a container with all the dependencies and dictionaries (tested on Ubuntu 24.04):
```bash
docker compose build
```
Or grab the latest prebuilt image:
```bash
docker pull itsupera/furiganalyse:latest
docker tag itsupera/furiganalyse:latest furiganalyse:latest
```
### Run as a web app
```bash
docker compose up -d
```
Then open http://127.0.0.1:5000 in your web browser
### Run as a CLI
```bash
# Run this from the directory your ebook (for example "book.epub") is in
docker run -v $PWD:/workspace --entrypoint=python3 furiganalyse:latest \
-m furiganalyse /workspace/book.epub /workspace/book_with_furigana.epub
```
### Calling the API
```bash
# Submit a job
curl -v -XPOST http://127.0.0.1/submit \
-F "file=@" \
-F furigana_mode="add" \
-F writing_mode="horizontal-tb" \
-F of="epub" \
-F redirect=false
# Response will look like this:
# {"uid":""}
# Check the status of the job
curl -v http://127.0.0.1/jobs//status
# Response will look like this:
# {
# "uid": "",
# "status": "complete",
# "result": "(...data...)"
# }
# Download the result
curl http://127.0.0.1/jobs//file -o output.epub
```
Local development setup
------------------------
Install python and poetry, (optionally) create a virtual environment, and install the dependencies:
```bash
poetry install
```