https://github.com/iwasakishuto/translation-gummy
Translation Gummy is a magical gadget which enables user to be able to speak and understand other languages.
https://github.com/iwasakishuto/translation-gummy
chromedriver deepl english-learning journal pypi python translation
Last synced: 7 months ago
JSON representation
Translation Gummy is a magical gadget which enables user to be able to speak and understand other languages.
- Host: GitHub
- URL: https://github.com/iwasakishuto/translation-gummy
- Owner: iwasakishuto
- License: mit
- Created: 2020-06-27T23:49:32.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-24T15:46:05.000Z (over 3 years ago)
- Last Synced: 2025-09-20T07:53:47.826Z (10 months ago)
- Topics: chromedriver, deepl, english-learning, journal, pypi, python, translation
- Language: Python
- Homepage: https://iwasakishuto.github.io/Translation-Gummy/index.html
- Size: 31.7 MB
- Stars: 89
- Watchers: 2
- Forks: 6
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Translation-Gummy

[](https://pypi.org/project/Translation-Gummy/)
[](https://github.com/iwasakishuto/Translation-Gummy)
[](https://github.com/iwasakishuto/Translation-Gummy/blob/master/.github/workflows/execute_python_package.yml)
[](https://github.com/iwasakishuto/Translation-Gummy/blob/master/.github/workflows/upload_python_package.yml)
[](https://github.com/iwasakishuto/Translation-Gummy/blob/master/LICENSE)
[](https://colab.research.google.com/github/iwasakishuto/Translation-Gummy/blob/master/examples/Colaboratory.ipynb)
[](https://github.com/iwasakishuto/Translation-Gummy/blob/master/docker/Dockerfile)
[](https://iwasakishuto.github.io/Translation-Gummy/index.html)
[](https://www.twitter.com/messages/compose?recipient_id=1042783905697288193&text=Please%20support%20this%20journal%3A%20)
[](https://qiita.com/cabernet_rock/items/670d5cd597bcd9f2ff3f)
[](https://qiita.com/cabernet_rock/items/1f9bff5e0b9363da312d)
[](https://elb.translation-gummy.com/)
[](https://github.com/sponsors/iwasakishuto)
[](https://elb.translation-gummy.com/slack_auth_begin)
**Translation Gummy** is a **_magical gadget_** which enables user to be able to speak and understand other languages. **※ Supported journals are listed [here](https://github.com/iwasakishuto/Translation-Gummy/wiki/Supported-journals).**
## Installation
1. Install **`Translation-Gummy`** (There are two ways to install):
- **Install from PyPI (recommended):**
```sh
$ sudo pip install Translation-Gummy
```
- **Alternatively: install `Translation-Gummy` from the GitHub source:**
```sh
$ git clone https://github.com/iwasakishuto/Translation-Gummy.git
# If you want to use the latest version (under development)
$ git clone -b develop https://github.com/iwasakishuto/Translation-Gummy.git
$ cd Translation-Gummy
$ sudo python setup.py install
```
2. Install **`wkhtmltopdf`**
- **Debian/Ubuntu:**
```sh
$ sudo apt-get install wkhtmltopdf
```
- **macOS:**
```sh
$ brew install homebrew/cask/wkhtmltopdf
```
3. Install **driver** for `selenium`:
**`Selenium`** requires a driver to interface with the chosen browser, so please visit the [documentation](https://selenium-python.readthedocs.io/installation.html#drivers) to install it.
```sh
# Example: Chrome
# visit "chrome://settings/help" to check your chrome version.
# visit "https://chromedriver.chromium.org/downloads" to check for your chrome.
$ wget https://chromedriver.storage.googleapis.com//chromedriver_mac64.zip
$ unzip chromedriver_mac64.zip
$ mv chromedriver /usr/local/bin/chromedriver
$ chmod +x /usr/local/bin/chromedriver
```
※ See [](https://github.com/iwasakishuto/Translation-Gummy/blob/master/docker/Dockerfile) or [](https://colab.research.google.com/github/iwasakishuto/Translation-Gummy/blob/master/examples/Colaboratory.ipynb) for more specific example.
### Pyenv + Poetry
- [Pyenv](https://github.com/pyenv/pyenv) is a python installation manager.
- [Poetry](https://python-poetry.org/) is a packaging and dependency manager.
I recommend you to use these tools to **avoid the chaos** of the python environment. See other sites for how to install these tools.
```sh
$ pyenv install 3.8.9
$ pyenv local 3.8.9
$ python -V
Python 3.8.9
# For Windows
$ poetry install -E windows
# For the other platform
$ poetry install
$ poetry run gummy-translate "This is a pen." --from-lang en --to-lang ja
$ poetry run gummy-journal "https://www.nature.com/articles/ncb0800_500"
```
## Quick example
- **[example notebooks](https://nbviewer.jupyter.org/github/iwasakishuto/Translation-Gummy/blob/master/examples/)**
- **Translation**:
- **Python Module:**
```python
>>> from gummy import TranslationGummy
>>> model = TranslationGummy(translator="deepl", from_lang="en", to_lang="ja")
[success] local driver can be built.
[failure] remote driver can't be built.
DRIVER_TYPE: local
>>> model.en2ja("This is a pen.")
DeepLTranslator (query1) 02/30[#-------------------] 6.67% - 2.144[s] translated: これはペン
'これはペンです。'
```
- **Command line:**
```sh
$ gummy-translate "This is a pen." --from-lang en --to-lang ja
[success] local driver can be built.
[failure] remote driver can't be built.
DRIVER_TYPE: local
DeepLTranslator (query1) 02/30[#-------------------] 6.67% - 2.185[s] translated: これはペン
これはペンです。
```
- **Output**

- **Create PDF (with translation)**
- **Python Module:**
```python
>>> from gummy import TranslationGummy
>>> model = TranslationGummy(gateway="utokyo", translator="deepl")
>>> pdfpath = model.toPDF(url="https://www.nature.com/articles/ncb0800_500", delete_html=True)
```
- **Command line:**
```sh
$ gummy-journal "https://www.nature.com/articles/ncb0800_500"
```
- **Output**
