https://github.com/ffreemt/deepl-fastapi
your own deepl server via fastapi, cross-platform (Windows/Linux/Mac)
https://github.com/ffreemt/deepl-fastapi
asyncio deepl fastapi pyppeteer pyppeteer2 scraper
Last synced: about 1 year ago
JSON representation
your own deepl server via fastapi, cross-platform (Windows/Linux/Mac)
- Host: GitHub
- URL: https://github.com/ffreemt/deepl-fastapi
- Owner: ffreemt
- License: mit
- Created: 2021-03-15T18:11:53.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-18T06:03:14.000Z (over 3 years ago)
- Last Synced: 2024-11-09T09:48:53.066Z (over 1 year ago)
- Topics: asyncio, deepl, fastapi, pyppeteer, pyppeteer2, scraper
- Language: Python
- Homepage:
- Size: 354 KB
- Stars: 49
- Watchers: 3
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# deepl-fastapi
[][](https://img.shields.io/static/v1?label=python+&message=3.7%2B&color=blue)[](https://github.com/psf/black)[](https://opensource.org/licenses/MIT)[](https://badge.fury.io/py/deepl-fastapi)
Your own deepl server via fastapi, cross-platform (Windows/Linux/MacOs) with API for OmegaT
## Installation
* Create a virual environment: optional but recommended
e.g.,
```bash
# Linux and friends
python3.7 -m venv .venv
source .venv/bin/activate
# Windows
# py -3.7 -m venv .venv
# .venv\Scripts\activate
```
```bash
pip install deepl-fastapi
```
or (if your use poetry)
```bash
poetry add deepl-fastapi
```
or
```
pip install git+https://github.com/ffreemt/deepl-fastapi.git
```
or
* Clone the repo [https://github.com/ffreemt/deepl-fastapi.git](https://github.com/ffreemt/deepl-fastapi.git)
```bash
git clone https://github.com/ffreemt/deepl-fastapi.git
```
and `cd deepl-fastapi`
* `pip install -r requirements.txt
* or ``poetry install``
## Usage
* Start the server
Use uvicorn directly (note the `deepl_server` module, not `run_uvicorn`)
```bash
uvicorn deepl_fastapi.deepl_server:app
```
or
```bash
deepl-fastapi
# this option is available only if installed via pip install or poetry add
```
or
```bash
python3.7 -m deepl_fastapi.run_uvicorn
```
or run the server on the external net, for example at port 9888
```
uvicorn deepl_fastapi.deepl_server:app --reload --host 0.0.0.0 --port 9888
```
* Explore and consume
Point your browser to [http://127.0.0.1:8000/text/?q=test&to_lang=zh](http://127.0.0.1:8000/text/?q=test&to_lang=zh)
Or in python code (`pip install requests` first)
```python
import requests
# get
url = "http://127.0.0.1:8000/text/?q=test me&to_lang=zh"
print(requests.get(url).json())
# {'q': 'test me', 'from_lang': None, 'to_lang': 'zh',
# 'trtext': '考我 试探我 测试我 试探'}
# post
text = "test this and that"
data = {"text": text, "to_lang": "zh"}
resp = requests.post("http://127.0.0.1:8000/text", json=data)
print(resp.json())
# {'q': {'text': 'test this and that', 'from_lang': None, 'to_lang': 'zh', 'description': None},
# 'result': '试探 左右逢源 检验 审时度势'}
```
## Interactive Docs (Swagger UI)
[http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs)
## OmegaT ``Fake MT`` plugin setup
* Copy ``omegat-plugin-fake-mt-1.0.0.jar`` （available at https://github.com/briacp/omegat-plugin-fake-mt） to OmegaT\plugins （e.g., C:\Program Files\OmegaT\plugins）
Run``OmegaT``and setup ``omegat-plugin-fake-mt``
```bash
OmegaT/Preferences/Machine Translation/Fake MT/Configure
Name: Fake Deepl MT
URL: http://localhost:8000/text
Source Parameter: from_lang
Target Parameter: to_lang
Text Parameter: q
```
