LibreTranslate 项目教程

LibreTranslate 项目教程

LibreTranslateFree and Open Source Machine Translation API. Self-hosted, offline capable and easy to setup.项目地址:https://gitcode.com/gh_mirrors/li/LibreTranslate

1. 项目的目录结构及介绍

LibreTranslate 是一个自由开源的机器翻译 API，支持自托管、离线使用且易于设置。以下是其主要目录结构及其介绍：

LibreTranslate/
├── babel.cfg
├── CONTRIBUTING.md
├── docker-compose.cuda.yml
├── docker-compose.yml
├── dockerignore
├── editorconfig
├── gitattributes
├── gitignore
├── k8s.yaml
├── LICENSE
├── manage.py
├── pre-commit-config.yaml
├── pyproject.toml
├── README.md
├── run.bat
├── scripts/
├── main.py
├── Dockerfile
└── requirements.txt

• babel.cfg: Babel 配置文件，用于国际化和本地化。
• CONTRIBUTING.md: 贡献指南。
• docker-compose.cuda.yml: 针对 CUDA 的 Docker Compose 配置文件。
• docker-compose.yml: Docker Compose 配置文件。
• dockerignore: Docker 忽略文件。
• editorconfig: 编辑器配置文件。
• gitattributes: Git 属性配置文件。
• gitignore: Git 忽略文件。
• k8s.yaml: Kubernetes 配置文件。
• LICENSE: 项目许可证。
• manage.py: 项目管理脚本。
• pre-commit-config.yaml: 预提交配置文件。
• pyproject.toml: Python 项目配置文件。
• README.md: 项目自述文件。
• run.bat: Windows 批处理启动脚本。
• scripts/: 包含各种脚本文件。
• main.py: 项目主启动文件。
• Dockerfile: Docker 构建文件。
• requirements.txt: Python 依赖包列表。

2. 项目的启动文件介绍

LibreTranslate 的主启动文件是 main.py。该文件包含了项目的核心逻辑和 API 接口定义。启动项目时，通常会运行这个文件来启动服务器。

# main.py
from flask import Flask, request, jsonify
from translate import Translator

app = Flask(__name__)

@app.route('/translate', methods=['POST'])
def translate():
    data = request.get_json()
    text = data['text']
    target_lang = data['target_lang']
    translator = Translator(to_lang=target_lang)
    result = translator.translate(text)
    return jsonify({'translated_text': result})

if __name__ == '__main__':
    app.run(host='0.0.0.0', port=5000)

3. 项目的配置文件介绍

LibreTranslate 的配置文件主要包括 docker-compose.yml 和 pyproject.toml。

docker-compose.yml

该文件用于定义 Docker 服务的配置，包括服务名称、镜像、端口映射等。

version: '3.8'
services:
  libretranslate:
    image: libretranslate/libretranslate
    ports:
      - "5000:5000"
    environment:
      - API_KEY=your_api_key

pyproject.toml

该文件用于定义 Python 项目的配置，包括项目元数据、依赖包等。

[tool.poetry]
name = "LibreTranslate"
version = "1.0.0"
description = "Free and Open Source Machine Translation API"
authors = ["LibreTranslate Contributors"]

[tool.poetry.dependencies]
python = "^3.8"
flask = "^2.0.1"
translate = "^3.5.0"

[tool.poetry.dev-dependencies]
pytest = "^6.2.4"

以上是 LibreTranslate 项目的基本教程，涵盖了目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。

LibreTranslateFree and Open Source Machine Translation API. Self-hosted, offline capable and easy to setup.项目地址:https://gitcode.com/gh_mirrors/li/LibreTranslate