Weblate istemcisi

Kurulum

The Weblate Client is shipped separately and includes the Python module. To use the commands below, you need to install wlc using pip:

pip install wlc

Ayrıca uvx ile doğrudan çalıştırabilirsiniz:

uvx wlc --help

İpucu

wlc bir Python modülü olarak da kullanılabilir. Ayrıntılı bilgi almak için: wlc.

Docker kullanımı

Weblate istemcisi, Docker kalıbı olarak da kullanılabilir.

Kalıp Docker Hub üzerinde bulunur: https://hub.docker.com/r/weblate/wlc

Kurulum:

docker pull weblate/wlc

The Docker container uses Weblate Client defaults and connects to the API deployed on localhost. Configure the API URL and API key using the normal wlc arguments or environment variables, for example --url, --key, WLC_URL, and WLC_KEY. API keys are rejected over non-local http:// URLs by default; use HTTPS, loopback HTTP for local development, or explicitly opt in to insecure HTTP.

Kapsayıcıyı başlatma komutu şu söz dizimini kullanır:

docker run --rm weblate/wlc [WLC_ARGS]

Örnek:

docker run --rm weblate/wlc --url https://hosted.weblate.org/api/ list-projects

Yapılandırma dosyaları dosyanızı Docker kapsayıcısına aktarmak isteyebilirsiniz. Deponuzda .weblate gibi bir proje yapılandırması bulunduğunda, en kolay yaklaşım var olan klasörünüzü /home/weblate birimi olarak eklemektir:

docker run --volume $PWD:/home/weblate --rm weblate/wlc show

When the mounted repository provides the API URL in project configuration and you pass an unscoped API key to the container, also pin the URL explicitly: WLC_KEY requires WLC_URL, and --key requires --url.

If the configured API URL uses non-local http:// and an API key is provided, the container refuses to send the key unless insecure HTTP is explicitly enabled. Prefer HTTPS; for legacy deployments, pass --allow-insecure-http or set WLC_ALLOW_INSECURE_HTTP.

Başlarken

Başlamanın en kolay yolu, ~.config/weblate içinde kişisel bir wlc yapılandırması oluşturmaktır (tam keşif kuralları ve diğer konumlar ile ilgili ayrıntılı bilgi almak için: Yapılandırma dosyaları):

[weblate]
url = https://hosted.weblate.org/api/

[keys]
https://hosted.weblate.org/api/ = APIKEY

Ardından varsayılan sunucuda komutları yürütebilirsiniz:

wlc ls
wlc commit sandbox/hello-world

Ayrıca bakınız

Yapılandırma dosyaları

Eski yapılandırma

1.17 sürümünde değişti: Kapsamsız key kullanan eski yapılandırma artık desteklenmiyor.

Eski yapılandırmayı aktarın:

[weblate]
url = https://hosted.weblate.org/api/
key = YOUR_KEY_HERE

Bir API adresi bulunan anahtar kapsamlı bir yapılandırmaya:

[weblate]
url = https://hosted.weblate.org/api/

[keys]
https://hosted.weblate.org/api/ = YOUR_KEY_HERE

Özet

wlc [arguments] <command> [options]

Komutlar aslında hangi işlemin yapılması gerektiğini belirtir.

Açıklama

Weblate Client, Weblate yönetiminin Weblate REST API uygulaması üzerinden yapılmasını sağlayan bir Python kitaplığı ve komut satırı uygulamasıdır. Komut satırı uygulaması wlc komutu ile çağrılabilir ve wlc modülü üzerinde bulunur.

Argümanlar

Çıktı biçimini veya hangi Weblate kopyasının kullanılacağını tanımlamak için aşağıdaki bağımsız değişkenler kullanılabilir. Bunlar herhangi bir komuttan önce yazılmalıdır.

--format {csv,json,text,html}

Çıktı biçimini belirtin.

--url URL

API adresini belirtir. Yapılandırma dosyasındaki tüm değerlerin yerini alır. Ayrıntılı bilgi almak için: Yapılandırma dosyaları. Adres /api/ ile bitmelidir. Örnek: https://hosted.weblate.org/api/.

--key KEY

Specify the API user key to use. Overrides any value found in the configuration file, see Yapılandırma dosyaları. You can find your key in your profile on Weblate. When the API URL is loaded from automatically discovered project configuration, --key must be used together with --url. API keys are rejected over non-local http:// URLs by default.

--allow-insecure-http

Allow sending API keys over non-local http:// URLs. Prefer HTTPS or loopback HTTP instead; this option is intended only for legacy deployments where HTTPS is not available. This option only enables insecure HTTP for the current run; omitting it does not disable allow_insecure_http from configuration.

--config PATH

Yapılandırmayı yalnızca keşfedilen genel ve proje yapılandırma dosyaları yerine PATH üzerinden yükleyin. Ayrıntılı bilgi almak için: Yapılandırma dosyaları.

--config-section SECTION

Kullanımdaki yapılandırma dosyası bölümünü değiştirir. Ayrıntılı bilgi almak için: Yapılandırma dosyaları.

Komutlar

Kullanılabilecek komutlar şunlardır:

version

Geçerli sürümü yazdırır.

list-languages

Weblate üzerinde kullanılan dilleri görüntüler.

list-projects

Weblate üzerindeki projeleri görüntüler.

list-components

Weblate üzerindeki bileşenleri görüntüler.

list-translations

Weblate üzerindeki çevirileri görüntüler.

show

Weblate nesnesini (çeviri, bileşen ya da proje) görüntüler.

ls

Weblate nesnesini (çeviri, bileşen ya da proje) görüntüler.

commit

Bir Weblate nesnesinde (çeviri, bileşen ya da proje) yapılan değişiklikleri işler.

pull

Uzak depo değişikliklerini Weblate nesnesine (çeviri, bileşen ya da proje) çeker.

push

Weblate nesnesindeki (çeviri, bileşen ya da proje) değişiklikleri uzak depoya iter.

reset

Uzak depoyla eşleşmesi için Weblate nesnesindeki (çeviri, bileşen ya da proje) değişiklikleri sıfırlar.

cleanup

Uzak depoyla eşleşmesi için bir Weblate nesnesindeki (çeviri, bileşen ya da proje) izlenmeyen değişiklikleri siler.

repo

Belirli bir Weblate nesnesi (çeviri, bileşen ya da proje) için depo durumunu görüntüler.

stats

Belirli bir Weblate nesnesi (çeviri, bileşen ya da proje) için ayrıntılı istatistikleri görüntüler.

lock-status

Kilit durumunu görüntüler.

lock

Weblate bileşenini kilitleyerek üzerinde daha fazla çeviri yapılmasını engeller.

unlock

Weblate bileşeninin kilidini açarak çeviri yapılmasını sağlar.

changes

Belirli bir nesnenin değişikliklerini görüntüler.

download

Bir çeviri dosyasını indirir.

--convert

Dosya biçimini dönüştürür. Belirtilmemişse sunucuda herhangi bir dönüştürme yapılmaz ve dosya depodan olduğu gibi indirilir.

--output

Çıktının kaydedileceği dosyayı belirtir. Belirtilmezse stdout çıkışına yazdırılır.

upload

Bir çeviri dosyasını yükler.

--overwrite

Yükleme yapılırken var olan çevirilerin üzerine yazar.

--input

İçeriği okunacak dosya. Belirtilmemişse stdin girişinden okunur.

--method

Kullanılacak yükleme yöntemi. Ayrıntılı bilgi almak için: İçe aktarma yöntemleri.

--fuzzy

Belirsiz (düzenlenecek olarak imlenmiş) dizgeleri işleme (empty, process, approve)

--author-name

Geçerli kullanıcı yerine kullanılacak yazar adı

--author-email

Geçerli kullanıcı yerine kullanılacak yazar e-posta adresi

İpucu

Komutların kullanımı ile ilgili ayrıntılı bilgi almak için --help seçeneğini kullanabilirsiniz. Örneğin: wlc ls --help.

Yapılandırma dosyaları

--config seçeneği belirtildiğinde, wlc yalnızca o dosyayı yükler.

--config seçeneği olmadan, wlc önce keşfedilen genel yapılandırma dosyasını standart platforma özgü konumlardan yükler:

C:\Users\KULLANICI\AppData\Roaming\weblate.ini

Windows üzerinde gezici profildeki genel yapılandırma dosyası.

C:\Users\KULLANICI\AppData\Local\weblate.ini

Windows üzerinde yerel profildeki genel yapılandırma dosyası.

~/.config/weblate

Unix benzeri sistemlerdeki genel yapılandırma dosyası.

/etc/xdg/weblate

Sistem geneli varsayılan yapılandırma dosyası.

Program XDG teknik özelliklerine uyar. Böylece XDG_CONFIG_HOME ya da XDG_CONFIG_DIRS ortam değişkenlerine göre yapılandırma dosyalarının konumunu ayarlayabilirsiniz.

Windows üzerinde yapılandırma dosyası için APPDATA veya LOCALAPPDATA klasörlerinin kullanılması yeğlenir.

Genel yapılandırmayı yükledikten sonra, wlc en yakın proje yapılandırma dosyasını geçerli klasörden veya üst klasörlerinden yükler:

.weblate, .weblate.ini, weblate.ini

Depoya yerleştirilmiş proje yapılandırma dosyası.

Yalnızca en yakın proje yapılandırma dosyası yüklenir. Daha uzak üst klasörlerdeki yapılandırma dosyaları göz ardı edilir.

[weblate] bölümünde şu ayarlar yapılandırılabilir (bunu --config-section ile özelleştirebilirsiniz):

key

Removed in version 1.17: Bireysel API adresleri için kapsamlı anahtarları belirtmek için [keys] bölümünü kullanın. Ayrıntılı bilgi almak için: Eski yapılandırma.

url

API sunucusunun adresi. Varsayılan değer: http://127.0.0.1:8000/api/.

translation

Varsayılan çeviri yolu. Bileşen ya da proje.

allow_insecure_http

Allow API keys over non-local http:// URLs, defaults to false. Loopback HTTP URLs, such as http://127.0.0.1:8000/api/, remain allowed for local development without this option. Prefer HTTPS instead of enabling this setting. Automatically discovered project configuration files cannot enable this option; set it in user configuration, an explicit --config file, WLC_ALLOW_INSECURE_HTTP, or --allow-insecure-http. The setting is cumulative: any trusted source that enables insecure HTTP is enough, and false or unset values from command-line or environment sources do not disable it.

retries, timeout, allowed_methods, backoff_factor, status_forcelist

İsteğe bağlı HTTP yeniden deneme ve zaman aşımı ayarları urllib3 üzerine aktarıldı. Yeniden denenebilecek istek yöntemlerini listelemek için allowed_methods kullanın. Var olan wlc sürümleri, eski method_whitelist seçeneği yerine bu ayar adını kullanır.

Yapılandırma dosyası bir INI dosyasıdır. Örneğin:

[weblate]
url = https://hosted.weblate.org/api/
translation = weblate/application
retries = 3
allowed_methods = PUT,POST,GET
backoff_factor = 0.2
status_forcelist = 429,500,502,503,504
timeout = 30
allow_insecure_http = false

API anahtarları [keys] bölümünde tutulur:

[keys]
https://hosted.weblate.org/api/ = APIKEY

This allows you to store keys in your personal settings, while using the .weblate configuration in the VCS repository so that wlc knows which server it should talk to. The [keys] lookup is scoped to the exact API URL.

In CI, unscoped keys must pin the API URL explicitly: set both WLC_URL and WLC_KEY, or use --url together with --key.

Ortam değişkenleri

Added in version 1.18.0.

2.0.1 sürümünde değişti: Unscoped API keys require an explicit API URL when project configuration is discovered automatically. API keys are rejected over non-local http:// URLs unless insecure HTTP is explicitly enabled.

The API URL and key can also be configured using environment variables. This is especially useful for CI workflows where WLC_URL pins the destination and WLC_KEY is injected as a secret:

WLC_URL

API adresi

WLC_KEY

API key. When the API URL would otherwise come from automatically discovered project configuration, WLC_KEY is accepted only together with WLC_URL. API keys are rejected over non-local http:// URLs by default.

WLC_ALLOW_INSECURE_HTTP

Set to 1, true, yes, or on to allow API keys over non-local http:// URLs. Prefer HTTPS or loopback HTTP instead. Other values, such as 0 or false, are treated as unset and do not disable allow_insecure_http from configuration.

The same protection applies to command-line arguments: --key is accepted with automatically discovered project configuration only when --url is provided.

The API URL and key configuration precedence (highest to lowest) is:

1. Komut satırı parametreleri (--url, --key).

2. Ortam değişkenleri (WLC_URL, WLC_KEY).

3. Yapılandırma --config seçeneğinden veya keşfedilen genel yapılandırmaya ek olarak --config kullanılmadığında en yakın proje yapılandırmasından yüklenir.

The insecure HTTP opt-in is enable-only rather than a normal precedence setting. It is enabled when --allow-insecure-http is passed, when WLC_ALLOW_INSECURE_HTTP has a true value, or when allow_insecure_http is enabled in trusted configuration. Automatically discovered project configuration cannot enable it; set it in user configuration or pass an explicit --config file instead.

Örnekler

Geçerli program sürümünü yazdır:

$ wlc version
version: 0.1

Tüm projeleri listele:

$ wlc list-projects
name: Hello
slug: hello
url: http://example.com/api/projects/hello/
web: https://weblate.org/
web_url: http://example.com/projects/hello/

Çeviri dosyasını yükle:

$ wlc upload project/component/language --input /tmp/hello.po

Ayrıca wlc hangi proje üzerinde çalışacak onu da belirleyebilirsiniz:

$ cat .weblate
[weblate]
url = https://hosted.weblate.org/api/
translation = weblate/application

$ wlc show
branch: main
file_format: po
source_language: en
filemask: weblate/locale/*/LC_MESSAGES/django.po
git_export: https://hosted.weblate.org/git/weblate/application/
license: GPL-3.0+
license_url: https://spdx.org/licenses/GPL-3.0+
name: Application
new_base: weblate/locale/django.pot
project: weblate
repo: git://github.com/WeblateOrg/weblate.git
slug: application
template:
url: https://hosted.weblate.org/api/components/weblate/application/
vcs: git
web_url: https://hosted.weblate.org/projects/weblate/application/

Bu kurulumla, geçerli projede bekleyen değişiklikler kolayca işlenebilir:

$ wlc commit