Cliant Gréasáin

Suiteáil

Seoltar an Weblate Client ar leithligh agus tá an modúl Python san áireamh ann. Chun na horduithe thíos a úsáid, ní mór duit wlc a shuiteáil ag baint úsáide as pip:

pip install wlc

Is féidir leat é a fhorghníomhú go díreach ag baint úsáide as uvx:

uvx wlc --help

Hint

Is féidir leat an wlc seo a úsáid mar mhodúl Python freisin, féach wlc.

Úsáid docker

Tá an Cliant Weblate ar fáil freisin mar íomhá Docker.

Tá an íomhá foilsithe ar Docker Hub: https://hub.docker.com/r/weblate/wlc

Suiteáil:

docker pull weblate/wlc

Úsáideann an coimeádán Docker réamhshocruithe Cliant Weblate agus nascann sé leis an API atá imscartha ar localhost. Cumraigh URL an API agus eochair an API ag baint úsáide as na hargóintí wlc nó na hathróga comhshaoil gnáth, mar shampla --url, --key, WLC_URL, agus WLC_KEY. Diúltaítear eochracha API thar URLanna http://` neamh-áitiúla de réir réamhshocraithe; bain úsáid as HTTPS, HTTP lúbtha siar le haghaidh forbartha áitiúla, nó roghnaigh go sainráite isteach i HTTP neamhshlán.

Úsáideann an t-ordú chun an coimeádán a sheoladh an chomhréir seo a leanas:

docker run --rm weblate/wlc [WLC_ARGS]

Sampla:

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

B’fhéidir gur mhaith leat do Comhaid chumraíochta a chur chuig an gcoimeádán Docker. Nuair a bhíonn cumraíocht tionscadail ar nós .weblate i do stór, is é an cur chuige is fusa ná d’eolaire reatha a chur leis mar an toirt /home/weblate:

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

Nuair a sholáthraíonn an stór suite URL an API i gcumraíocht an tionscadail agus nuair a chuireann tú eochair API neamhscóipithe chuig an gcoimeádán, bioráin an URL go sainráite freisin: éilíonn WLC_KEY WLC_URL, agus éilíonn --key --url.

Má úsáideann an URL API cumraithe http:// neamh-áitiúil agus má chuirtear eochair API ar fáil, diúltaíonn an coimeádán an eochair a sheoladh mura bhfuil HTTP neamhshlán cumasaithe go sainráite. Is fearr HTTPS; i gcás imscaradh oidhreachta, pasáil --allow-insecure-http nó socraigh WLC_ALLOW_INSECURE_HTTP.

Ag tosú

Is é an bealach is fusa le tosú ná cumraíocht phearsanta wlc a chruthú i ~/.config/weblate (féach Comhaid chumraíochta le haghaidh na rialacha fionnachtana iomlána agus suíomhanna eile):

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

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

Is féidir leat orduithe a agairt ansin ar an bhfreastalaí réamhshocraithe:

wlc ls
wlc commit sandbox/hello-world

See also

Comhaid chumraíochta

Cumraíocht oidhreachta

Changed in version 1.17: Ní thacaítear a thuilleadh leis an seanchumraíocht a úsáideann key neamhscóipithe.

Cumraíocht oidhreachta a aistriú:

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

Chuig cumraíocht le heochair atá teoranta do URL API:

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

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

Achoimre

wlc [arguments] <command> [options]

Léiríonn orduithe i ndáiríre cén oibríocht ba cheart a dhéanamh.

Cur síos

Is leabharlann Python agus áirgiúlacht ordú-líne é Weblate Cliant chun Weblate a bhainistiú go cianda ag baint úsáide as API REST Weblate. Is féidir an áirgiúlacht líne ordaithe a agairt mar wlc agus tá sé ionsuite ar wlc.

Argóintí

Glacann an clár leis na hargóintí seo a leanas a shainíonn formáid aschuir nó a bhfuil Weblate mar shampla le húsáid. Ní mór iad seo a chur isteach roimh aon ordú.

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

Sonraigh an fhormáid aschuir.

--url URL

Sonraigh an URL API. Sáraíonn sé aon luach a fhaightear sa chomhad cumraíochta, féach Comhaid chumraíochta. Ba cheart go gcríochnódh an URL le /api/, mar shampla https://hosted.weblate.org/api/.

--key KEY

Sonraigh an eochair úsáideora API le húsáid. Sáraíonn sé aon luach a fhaightear sa chomhad cumraíochta, féach Comhaid chumraíochta. Is féidir leat d'eochair a fháil i do phróifíl ar Weblate. Nuair a luchtaítear URL an API ó chumraíocht tionscadail a aimsítear go huathoibríoch, ní mór --key a úsáid in éineacht le --url. Diúltaítear d'eochracha API thar URLanna http:// neamh-áitiúla de réir réamhshocraithe.

--allow-insecure-http

Ceadaigh eochracha API a sheoladh thar URLanna neamh-áitiúla http://. Is fearr HTTPS nó HTTP lúbtha ina ionad; níl an rogha seo beartaithe ach le haghaidh imscaradh oidhreachta nach bhfuil HTTPS ar fáil iontu. Ní chumasaíonn an rogha seo ach HTTP neamhshábháilte don rith reatha; ní dhíchumasaíonn sé allow_insecure_http ón chumraíocht má fhágann tú ar lár é.

--config PATH

Luchtaigh cumraíocht ó PATH amháin in ionad na gcomhad cumraíochta domhanda agus tionscadail a aimsíodh, féach Comhaid chumraíochta.

--config-section SECTION

Sáraítear an roinn comhaid cumraíochta atá in úsáid, féach Comhaid chumraíochta.

Orduithe

Tá na horduithe seo a leanas ar fáil:

version

Priontálann an leagan reatha.

list-languages

Liostaíonn na teangacha a úsáidtear i Weblate.

list-projects

Liostaíonn sé na tionscadail i Weblate.

list-components

Liostaíonn sé comhpháirteanna i Weblate.

list-translations

Liostaíonn sé aistriúcháin i Weblate.

show

Taispeáin réad Weblate (aistriúchán, comhpháirt nó tionscadal).

ls

Liostaíonn réad Weblate (aistriúchán, comhpháirt nó tionscadal).

commit

Geallann sé athruithe a dhéantar ar réad Weblate (aistriúchán, comhpháirt nó tionscadal).

pull

Tarraingíonn cianathruithe stórtha isteach i réad Weblate (aistriúchán, comhpháirt nó tionscadal).

push

Athraíonn oibiacht Weblate a bhrú isteach i cianthaisc (aistriúchán, comhpháirt nó tionscadal).

reset

Athshocraigh athruithe ar oibiacht Weblate chun cianthaisc a mheaitseáil (aistriúchán, comhpháirt nó tionscadal).

cleanup

Baintear aon athruithe neamhrianaithe i réad Weblate chun teacht leis an gcianstór (aistriúchán, comhpháirt nó tionscadal).

repo

Taispeánann sé stádas stór do réad Weblate ar leith (aistriúchán, comhpháirt nó tionscadal).

stats

Taispeánann sé staitisticí mionsonraithe maidir le réad Weblate ar leith (aistriúchán, comhpháirt nó tionscadal).

lock-status

Léiríonn stádas glasála.

lock

Glasáil an chomhpháirt ó aistriúchán breise i Weblate.

unlock

Díghlasáiltear aistriúchán comhpháirt Weblate.

changes

Taispeáin athruithe do réad ar leith.

download

Íosluchtaigh comhad aistriúcháin.

--convert

Athraíonn sé formáid comhaid, mura dtarlaíonn comhshó ar an bhfreastalaí mura bhfuil sé sonraithe agus íoslódáltar an comhad mar atá chuig an stór.

--output

Sonraítear an comhad chun an t-aschur a shábháil ann, má fhágtar é gan sonraíocht clóitear é chuig stdout.

upload

Uaslódálann sé comhad aistriúcháin.

--overwrite

Forscríobh aistriúcháin atá ann cheana féin agus iad á n-uaslódáil.

--input

Comhad óna léitear ábhar, mura bhfuil sé sonraithe léitear é ó stdin.

--method

Modh uaslódáil le húsáid, féach Modhanna allmhairithe.

--fuzzy

Próiseáil teaghráin doiléir (marcáilte le haghaidh eagarthóireachta) (folamh, próiseas, faomh)

--author-name

Ainm an údair, chun an t-úsáideoir fíordheimhnithe faoi láthair a shárú

--author-email

Ríomhphost an údair, chun an t-úsáideoir fíordheimhnithe faoi láthair a shárú

Hint

Is féidir leat faisnéis níos mionsonraithe a fháil maidir le horduithe aonair a agairt trí --help a chur isteach, mar shampla: wlc ls --help.

Comhaid chumraíochta

Nuair a chuirtear --config ar fáil, ní luchtóidh wlc ach an comhad sin.

Gan --config, luchtóidh wlc an comhad cumraíochta domhanda a aimsíodh ar dtús ó na suíomhanna caighdeánacha ardáin-shonracha:

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

Comhad cumraíochta domhanda ar Windows sa phróifíl fánaíochta.

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

Comhad cumraíochta domhanda ar Windows sa phróifíl áitiúil.

~/.config/weblate

Comhad cumraíochta domhanda ar chórais cosúil le Unix.

/etc/xdg/weblate

Comhad cumraíochta taca don chóras ar fad.

Leanann an clár sonraíocht XDG, mar sin is féidir leat suíomh na gcomhad cumraíochta a choigeartú de réir athróg timpeallachta XDG_CONFIG_HOME nó XDG_CONFIG_DIRS.

Ar Windows is iad na heolairí APPDATA agus LOCALAPPDATA na suíomhanna is fearr don chomhad cumraíochta.

Tar éis an chumraíocht dhomhanda a luchtú, luchtóidh wlc an comhad cumraíochta tionscadail is gaire ón eolaire reatha nó óna thuismitheoirí:

.weblate, .weblate.ini, weblate.ini

Comhad cumraíochta tionscadail curtha sa stórlann.

Ní luchtaítear ach an comhad cumraíochta tionscadail is gaire. Déantar neamhaird de chomhaid chumraíochta i gcomhadlanna tuismitheora níos faide i gcéin.

Is féidir na socruithe seo a leanas a chumrú sa rannán [weblate] (is féidir leat é seo a shaincheapadh trí --config-section):

key

Removed in version 1.17: Úsáid an chuid [keys] chun eochracha a shonrú atá raon feidhme do URLanna API aonair, féach Cumraíocht oidhreachta.

url

URL freastalaí API, réamhshocraithe go http://127.0.0.1:8000/api/.

translation

Conair chuig an aistriúchán réamhshocraithe - comhpháirt nó tionscadal.

allow_insecure_http

Ceadaigh eochracha API thar URLanna neamh-áitiúla http://, is é bréagach an réamhshocrú. Fanann URLanna HTTP lúbtha siar, amhail http://127.0.0.1:8000/api/, ceadaithe le haghaidh forbartha áitiúla gan an rogha seo. Is fearr HTTPS in ionad an socrú seo a chumasú. Ní féidir le comhaid chumraíochta tionscadail a aimsítear go huathoibríoch an rogha seo a chumasú; socraigh é i gcumraíocht úsáideora, comhad --config follasach, WLC_ALLOW_INSECURE_HTTP, nó --allow-insecure-http. Tá an socrú carnach: is leor aon fhoinse iontaofa a chumasaíonn HTTP neamhshábháilte, agus ní dhíchumasaíonn luachanna bréagacha nó neamhshocraithe ó fhoinsí líne ordaithe nó timpeallachta é.

retries, timeout, allowed_methods, backoff_factor, status_forcelist

Socruithe roghnacha athiarrachta agus sos ama HTTP curtha chuig urllib3. Úsáid allowed_methods chun na modhanna iarrata is féidir a athiarracht a liostáil. Úsáideann na heisiúintí reatha wlc an t-ainm socraithe seo in ionad an rogha method_whitelist atá ann cheana.

Is comhad INI é an comhad cumraíochta, mar shampla:

[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

Stóráiltear eochracha an API sa rannán [keys]:

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

Ligeann sé seo duit eochracha a stóráil i do shocruithe pearsanta, agus an chumraíocht .weblate á húsáid agat sa stór VCS ionas go mbeidh a fhios ag wlc cén freastalaí ba chóir dó labhairt leis. Tá an cuardach [keys] teoranta don URL API cruinn.

I CI, ní mór d'eochracha neamhscóipeáilte an URL API a phionáil go sainráite: socraigh WLC_URL agus WLC_KEY araon, nó bain úsáid as --url mar aon le --key.

Athróga timpeallachta

Added in version 1.18.0.

Changed in version 2.0.1: Éilíonn eochracha API neamhscóipeáilte URL API sainráite nuair a aimsítear cumraíocht tionscadail go huathoibríoch. Diúltaítear d'eochracha API thar URLanna neamh-áitiúla http:// mura bhfuil HTTP neamhshlán cumasaithe go sainráite.

Is féidir URL agus eochair an API a chumrú ag baint úsáide as athróga comhshaoil freisin. Tá sé seo an-úsáideach go háirithe le haghaidh sreafaí oibre CI ina mbiorann WLC_URL an ceann scríbe agus ina n-instealltar WLC_KEY mar rún:

WLC_URL

URL API

WLC_KEY

Eochair API. Nuair a thiocfadh an URL API ó chumraíocht tionscadail a aimsítear go huathoibríoch murach sin, ní ghlactar le WLC_KEY ach amháin i dteannta WLC_URL. Diúltaítear eochracha API thar URLanna http:// neamh-áitiúla de réir réamhshocraithe.

WLC_ALLOW_INSECURE_HTTP

Socraigh go 1, fíor, tá, nó ar chun eochracha API a cheadú thar URLanna neamh-áitiúla http://. Is fearr HTTPS nó HTTP lúbtha ina ionad. Meastar nach bhfuil luachanna eile, amhail 0 nó bréagach, socraithe agus ní dhíchumasaíonn siad allow_insecure_http ón chumraíocht.

Baineann an chosaint chéanna le hargóintí líne ordaithe: ní ghlactar le --key le cumraíocht tionscadail a aimsítear go huathoibríoch ach amháin nuair a chuirtear --url ar fáil.

Is é URL an API agus tosaíocht chumraíochta eochrach (ón gceann is airde go dtí an ceann is ísle) ná:

1. Argóintí líne ordaithe (--url, --key).

2. Athróga timpeallachta (WLC_URL, WLC_KEY).

3. Cumraíocht luchtaithe ó --config, nó ón gcumraíocht dhomhanda a aimsíodh móide an chumraíocht tionscadail is gaire nuair nach n-úsáidtear --config.

Is socrú cumasaithe amháin é an rogha isteach HTTP neamhshlán seachas gnáthshocrú tosaíochta. Cumasaítear é nuair a chuirtear --allow-insecure-http ar aghaidh, nuair a bhíonn fíorluach ag WLC_ALLOW_INSECURE_HTTP, nó nuair a bhíonn allow_insecure_http cumasaithe i gcumraíocht iontaofa. Ní féidir le cumraíocht tionscadail a aimsítear go huathoibríoch é a chumasú; socraigh é i gcumraíocht an úsáideora nó cuir comhad --config sainráite ar aghaidh ina ionad.

Samplaí

Priontáil leagan reatha an chláir:

$ wlc version
version: 0.1

Liostaigh gach tionscadal:

$ 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/

Uaslódáil comhad aistriúcháin:

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

Is féidir leat a ainmniú freisin cén tionscadal wlc ba chóir a bheith ag obair air:

$ 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/

Leis an socrú seo is furasta athruithe a dhéanamh ar feitheamh ar an tionscadal reatha:

$ wlc commit