Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sharplab/epub-translator

An utility to translate epub books with DeepL
https://github.com/sharplab/epub-translator

Last synced: 7 days ago
JSON representation

An utility to translate epub books with DeepL

Awesome Lists containing this project

README

        

# epub-translator

[![Actions Status](https://github.com/sharplab/epub-translator/workflows/CI/badge.svg)](https://github.com/sharplab/epub-translator/actions)

epub-translator is an utility to translate EPub books.

- Utilize [DeepL API](https://www.deepl.com/ja/docs-api/) (You need to register DeepL API plan)
- Leave the original text for reference, and insert the translated text below per paragraph

![Translation sample](./docs/image/translation-sample.png)

This project uses Quarkus, the Supersonic Subatomic Java Framework.
If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .

## Build

### Prerequisites

- JDK 11

### Creating an uber-jar

The application can be packaged using following command:

```
./gradlew quarkusBuild -D quarkus.package.type=uber-jar
```

It produces the `epub-translator-runner.jar` file in the `build` directory.

## Configuration

place application.yml to `/config/application.yml`

#### application.yml

```
ePubTranslator:
deepL:
apiEndpoint: https://api.deepl.com # If you subscribe free API plan, use "https://api-free.deepl.com" instead.
apiKey:
language:
source: en # default source language
destination: ja # default destination language

```

## Execution

uber-jar

```
java -jar epub-translator-runner.jar --src [--dst ] \
[--srcLang ] [--dstLang ]
```