Client Weblate
Nou în versiunea 2.7: A existat un suport complet pentru utilitarul wlc încă de la Weblate 2.7. Dacă folosiți o versiune mai veche, pot apărea unele incompatibilități cu API-ul.
Instalare
Weblate Client este livrat separat și include modulul Python. Pentru a utiliza comenzile de mai jos, trebuie să instalați wlc
:
pip install wlc
Utilizarea Docker
Clientul Weblate este, de asemenea, disponibil ca o imagine Docker.
Imaginea este publicată pe Docker Hub: https://hub.docker.com/r/weblate/wlc
Instalare:
docker pull weblate/wlc
Containerul Docker utilizează setările implicite ale Weblate și se conectează la API-ul implementat în localhost. URL-ul API și API_KEY pot fi configurate prin intermediul argumentelor acceptate de Weblate.
Comanda de lansare a containerului utilizează următoarea sintaxă:
docker run --rm weblate/wlc [WLC_ARGS]
Exemplu:
docker run --rm weblate/wlc --url https://hosted.weblate.org/api/ list-projects
S-ar putea să doriți să treceți Fișiere de configurare la containerul Docker, cea mai simplă abordare este să adăugați directorul curent ca volum /home/weblate
:
docker run --volume $PWD:/home/weblate --rm weblate/wlc show
Noțiuni introductive
Configurația wlc este stocată în ~/.config/weblate
(vezi Fișiere de configurare pentru alte locații), vă rugăm să o creați pentru a se potrivi cu mediul dumneavoastră:
[weblate]
url = https://hosted.weblate.org/api/
[keys]
https://hosted.weblate.org/api/ = APIKEY
Apoi puteți invoca comenzi pe serverul implicit:
wlc ls
wlc commit sandbox/hello-world
Vezi și
Sinopsis
wlc [arguments] <command> [options]
Comenzile indică de fapt ce operațiune trebuie efectuată.
Descriere
Weblate Client este o bibliotecă Python și un utilitar de linie de comandă pentru a gestiona Weblate de la distanță folosind Weblate’s REST API. Utilitarul de linie de comandă poate fi invocat ca wlc și este încorporat în wlc
.
Argumente
Programul acceptă următoarele argumente care definesc formatul de ieșire sau instanța Weblate care trebuie utilizată. Acestea trebuie introduse înainte de orice comandă.
- --format {csv,json,text,html}
Specificați formatul de ieșire.
- --url URL
Specificați URL-ul API. Suprascrie orice valoare găsită în fișierul de configurare, a se vedea Fișiere de configurare. URL-ul trebuie să se termine cu
/api/
, de exempluhttps://hosted.weblate.org/api/
.
- --key KEY
Specificați cheia de utilizator API care urmează să fie utilizată. Suprascrie orice valoare găsită în fișierul de configurare, a se vedea Fișiere de configurare. Puteți găsi cheia dvs. în profilul vostru pe Weblate.
- --config PATH
Suprascrie calea fișierului de configurare, a se vedea Fișiere de configurare.
- --config-section SECTION
Suprascrie secțiunea fișierului de configurare în uz, a se vedea Fișiere de configurare.
Comenzi
Sunt disponibile următoarele comenzi:
- version
Tipărește versiunea curentă.
- list-languages
Listează limbile utilizate în Weblate.
- list-projects
Listează proiectele din Weblate.
- list-components
Listează componentele din Weblate.
- list-translations
Listează traducerile din Weblate.
- show
Afișează obiectul Weblate (traducere, componentă sau proiect).
- ls
Listează obiectul Weblate (traducere, componentă sau proiect).
- commit
Comută modificările efectuate într-un obiect Weblate (traducere, componentă sau proiect).
- pull
Atrage modificările din depozitul de la distanță în obiectul Weblate (traducere, componentă sau proiect).
- push
Împinge modificările obiectelor Weblate în depozitul la distanță (traducere, componentă sau proiect).
- reset
Nou în versiunea 0.7: Compatibil începând cu wlc 0.7.
Resetează modificările din obiectul Weblate pentru a se potrivi cu depozitul la distanță (traducere, componentă sau proiect).
- cleanup
Nou în versiunea 0.9: Compatibil începând cu wlc 0.9.
Îndepărtează orice modificări netrasate într-un obiect Weblate pentru a se potrivi cu depozitul la distanță (traducere, componentă sau proiect).
- repo
Afișează starea depozitului pentru un anumit obiect Weblate (traducere, componentă sau proiect).
- stats
Afișează statistici detaliate pentru un anumit obiect Weblate (traducere, componentă sau proiect).
- lock-status
Nou în versiunea 0.5: Suportat de la wlc 0.5.
Afișează starea de blocare.
- lock
Nou în versiunea 0.5: Suportat de la wlc 0.5.
Blochează componenta de la traducerea ulterioară în Weblate.
- unlock
Nou în versiunea 0.5: Suportat de la wlc 0.5.
Deblochează traducerea componentei Weblate.
- changes
Nou în versiunea 0.7: Compatibil începând cu wlc 0.7 și Weblate 2.10.
Afișează modificările pentru un anumit obiect.
- download
Nou în versiunea 0.7: Compatibil începând cu wlc 0.7.
Descarcă un fișier de traducere.
- --convert
Convertește formatul fișierului; dacă nu este specificat, nu are loc nicio conversie pe server, iar fișierul este descărcat ca atare în depozit.
- --output
Specifică fișierul în care se salvează ieșirea; dacă nu este specificat, aceasta este imprimată în stdout.
- upload
Nou în versiunea 0.9: Compatibil începând cu wlc 0.9.
Încarcă un fișier de traducere.
- --overwrite
Suprascrieți traducerile existente în momentul încărcării.
- --input
Fișier din care se citește conținutul; dacă nu este specificat, se citește din stdin.
- --method
Metoda de încărcare care trebuie utilizată, a se vedea Metode de import.
- --fuzzy
Procesarea șirurilor fuzzy (marcate pentru editare) (empty,
process
,approve
)
- --author-name
Numele autorului, pentru a suprascrie utilizatorul autentificat în prezent
- --author-email
E-mailul autorului, pentru a suprascrie utilizatorul autentificat în prezent
Sugestie
Puteți obține informații mai detaliate despre invocarea comenzilor individuale trecând --help
, de exemplu: wlc ls --help
.
Fișiere de configurare
.weblate
,.weblate.ini
,weblate.ini
Schimbat în versiunea 1.6: Sunt acceptate și fișierele cu extensia .ini.
Fișier de configurare pentru fiecare proiect
C:\Users\NAME\AppData\weblate.ini
Nou în versiunea 1.6.
Fișier de configurare a utilizatorului pe Windows.
~/.config/weblate
Fișier de configurare a utilizatorului
/etc/xdg/weblate
Fișier de configurare la nivel de sistem
Programul urmează specificațiile XDG, astfel încât puteți ajusta plasarea fișierelor de configurare prin variabilele de mediu XDG_CONFIG_HOME
sau XDG_CONFIG_DIRS
. Pe Windows, directorul APPDATA
este locația preferată pentru fișierul de configurare.
Următoarele setări pot fi configurate în secțiunea [weblate]
(puteți personaliza acest lucru prin --config-section
):
- key
API KEY pentru a accesa Weblate.
- url
URL-ul serverului API, valoarea implicită este
http://127.0.0.1:8000/api/
.
- translation
Calea către traducerea implicită - componentă sau proiect.
Fișierul de configurare este un fișier INI, de exemplu:
[weblate]
url = https://hosted.weblate.org/api/
key = APIKEY
translation = weblate/application
În plus, cheile API pot fi stocate în secțiunea [keys]
:
[keys]
https://hosted.weblate.org/api/ = APIKEY
Acest lucru vă permite să stocați cheile în setările personale, utilizând în același timp configurația .weblate
din depozitul VCS, astfel încât wlc să știe cu ce server trebuie să vorbească.
Exemple
Imprimă versiunea curentă a programului:
$ wlc version
version: 0.1
Enumerați toate proiectele:
$ 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/
Încărcați fișierul de traducere:
$ wlc upload project/component/language --input /tmp/hello.po
Puteți, de asemenea, să desemnați la ce proiect ar trebui să lucreze wlc:
$ 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/
Cu această configurație, este ușor să confirmați modificările în așteptare în proiectul curent:
$ wlc commit