Weblate のカスタマイズ¶

Django と Python を使用して拡張およびカスタマイズします。変更を上流に還元して、誰もが恩恵を受けられるようにしてください。これにより、あなたの保守コストが削減されます。Weblate に入ったコードは、内部インターフェイスの変更やコードのリファクタリング時に考慮されます。

ヒント

外観のカスタマイズで Weblate の外観をカスタマイズすることもできます。

警告

内部インターフェイスもテンプレートも、安定した API とはいえません。インターフェイスまたはそのセマンティクスは予告なく変更されますので、アップグレードごとに独自のカスタマイズを見直してください。

参考

Weblate に貢献

Python モジュールの作成¶

Python に慣れていない場合は、Python For Beginners を調べて、基本の説明とチュートリアルを参考にしてください。

（モジュールと呼ばれる）Python のカスタムコードを含むファイルを作成するには、それを格納する場所が必要です。システムパス（通常は /usr/lib/python3.12/site-packages/ など）か、インタプリタ検索パスに追加された Weblate ディレクトリのどちらかになります。

ヒント

Docker を使用したインストールの場合、Python モジュールを /app/data/python/ （参照: Docker コンテナのボリューム）にに配置できます。これにより、上書き設定ファイルから Weblate に読み込ませることができます。

カスタマイズしたものを適切な Python パッケージに変更すると、さらに良くなります。

パッケージ用のフォルダを作成する（weblate_customization を使用する）。

その中に、パッケージを記述するための pyproject.toml ファイルを作成する。作成方法:

[build-system]
requires = ["uv_build>=0.8.18,<0.9.0"]
build-backend = "uv_build"

[project]
name = "weblate-customization"
version = "0.1.0"
description = "Add your description here"
requires-python = ">=3.13"
dependencies = []

Python モジュール用のフォルダ src/weblate_customization を作成する。
その中に __init__.py ファイルを作成し、Python がモジュールをインポートできることを確認する。
このパッケージは、uv pip install -e を使用してインストールできるようになりました。詳細については、Editable packages documentation を確認してください。
インストールが完了すると、モジュールは Weblate の設定から使用できるようになります（weblate_customization.checks.FooCheck など）。

出来上がったパッケージ構造:

weblate_customization
├── pyproject.toml
└── src
    └── weblate_customization
        ├── __init__.py
        ├── addons.py
        └── checks.py

Weblate のカスタマイズ例は、<https://github.com/WeblateOrg/customize-example> にあります。ここでは、次に説明するすべてのトピックについて説明します。カスタマイズ例は、以下に説明するトピックをすべて網羅しています。

ロゴの変更¶

上書きしたい静的ファイルを含む単純な Django アプリケーションを作成します（参照: Python モジュールの作成）。

表示するロゴのファイル:

icons/weblate.svg
ナビゲーションバーに表示するロゴ。

logo-*.png
画面の解像度と Web ブラウザーに応じた Web アイコン。

favicon.ico
従来のブラウザーで使用する Web アイコン。

weblate-*.png
ボットまたは匿名ユーザー用のアバター。一部の Web ブラウザーでは、これをショートカットアイコンとして使用する。

email-logo.png
通知メールに使用する。

これを、INSTALLED_APPS に追加する方法:

INSTALLED_APPS = (
    # Add your customization as first
    "weblate_customization",
    # Weblate apps are here…
)

weblate collectstatic --noinput を実行し、クライアントに提供する静的ファイルをまとめます。

参考

品質検査、アドオン、自動提案、自動修正のカスタマイズ¶

自動修正のカスタマイズ、独自の検査項目の作成、カスタム機械翻訳またはアドオンの作成のコードを Weblate にインストールする方法:

Weblate のカスタマイズを含む、Python モジュール内にファイルを置く（参照: Python モジュールの作成またはコードのカスタマイズ）。
専用の設定で、その Python クラスへの完全修飾パスを追加します。

# Checks
CHECK_LIST += ("weblate_customization.checks.FooCheck",)

# Autofixes
AUTOFIX_LIST += ("weblate_customization.autofix.FooFixer",)

# Add-ons
WEBLATE_ADDONS += ("weblate_customization.addons.ExamplePreAddon",)

# Automatic suggestions
WEBLATE_MACHINERY += ("weblate_customization.machinery.SampleTranslation",)

参考