Cliente Weblate¶

Instalação¶

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

Dica

You can also use this wlc as a Python module, see wlc.

Uso do Docker¶

O Weblate Client também está disponível como uma imagem Docker.

A imagem está publicada no Docker Hub: https://hub.docker.com/r/weblate/wlc

Instalar:

docker pull weblate/wlc

O contentor Docker usa as configurações padrão do Weblate e se conecta à API implementada no localhost. A URL da API e API_KEY podem ser configuradas através dos argumentos aceitos pelo Weblate.

O comando para iniciar o contentor usa a seguinte sintaxe:

docker run --rm weblate/wlc [WLC_ARGS]

Exemplo:

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

Quereria passar o seu Ficheiros de configuração para o contentor Docker, a abordagem mais fácil é adicionar o seu diretório atual como o volume /home/weblate:

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

Primeiros Passos¶

The wlc configuration is stored in ~/.config/weblate (see Ficheiros de configuração for other locations), please create it to match your environment:

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

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

Depois pode invocar comandos no servidor predefinido:

wlc ls
wlc commit sandbox/hello-world

Veja também

Ficheiros de configuração

Sinopse¶

wlc [arguments] <command> [options]

Os comandos indicam, na verdade, qual operação deve ser realizada.

Descrição¶

O cliente Weblate é uma biblioteca Python e utilitário de linha de comando para gerir o Weblate remotamente a usar a API REST do Weblate. O utilitário de linha de comando pode ser invocado como wlc e está embutido em wlc.

Argumentos¶

O programa aceita os seguintes argumentos que definem o formato de saída ou qual a instância do Weblate a utilizar. Estes devem ser introduzidos antes de qualquer comando.

--format {csv,json,text,html}¶: Especifica o formato de saída.

--url URL¶: Especifica a URL da API. Substitui qualquer valor encontrado no ficheiro de configuração, consulte Ficheiros de configuração. A URL deve terminar com /api/, por exemplo, https://hosted.weblate.org/api/.

--key KEY¶: Especifica a chave do utilizador de API a ser usada. Substitui qualquer valor encontrado no ficheiro de configuração, consulte Ficheiros de configuração. Pode encontrar a sua chave no seu perfil no Weblate.

--config PATH¶: Substitui o caminho do ficheiro de configuração, consulte Ficheiros de configuração.

--config-section SECTION¶: Substitui a secção de ficheiros de configuração em uso, consulte Ficheiros de configuração.

Comandos¶

Os comandos seguintes estão disponíveis:

version¶: Imprime a versão atual.

list-languages¶: Lista os idiomas usados no Weblate.

list-projects¶: Lista os projetos no Weblate.

list-components¶: Lista os componentes no Weblate.

list-translations¶: Lista as traduções no Weblate.

show¶: Mostra o objeto do Weblate (tradução, componente ou projeto).

ls¶: Lista o objeto do Weblate (tradução, componente ou projeto).

commit¶: Faz um commit das alterações feitas num objeto Weblate (tradução, componente ou projeto).

pull¶: Faz um pull das alterações remotas do repositório no objeto Weblate (tradução, componente ou projeto).

push¶: Faz um push das alterações do objeto Weblate ao repositório remoto (tradução, componente ou projeto).

reset¶: Added in version 0.7: Suportado desde o wlc 0.7.

Redefine as alterações no objeto Weblate para corresponder ao repositório remoto (tradução, componente ou projeto).

cleanup¶: Added in version 0.9: Suportado desde o wlc 0.9.

Remove todas as alterações não rastreadas num objeto Weblate para corresponder ao repositório remoto (tradução, componente ou projeto).

repo¶: Exibe o estado do repositório para um determinado objeto do Weblate (tradução, componente ou projeto).

stats¶: Exibe estatísticas detalhadas para um determinado objeto Weblate (tradução, componente ou projeto).

lock-status¶: Added in version 0.5: Suportado desde o wlc 0.5.

Exibe o estado do bloqueio.

lock¶: Added in version 0.5: Suportado desde o wlc 0.5.

Bloqueia o componente de tradução posterior no Weblate.

unlock¶: Added in version 0.5: Suportado desde o wlc 0.5.

Desbloqueia a tradução do componente Weblate.

changes¶: Added in version 0.7: Suportado desde o wlc 0.7 e o Weblate 2.10.

Exibe alterações para um determinado objeto.

download¶

Added in version 0.7: Suportado desde o wlc 0.7.

Descarrega um ficheiro de tradução.

--convert¶: Converte o formato do ficheiro, se nenhuma conversão não especificada for feita no servidor e o ficheiro for descarregado como está no repositório.

--output¶: Especifica o ficheiro para gravar a saída e se não for especificado é impresso na stdout (saída predefinida).

upload¶

Added in version 0.9: Suportado desde o wlc 0.9.

Descarrega um ficheiro de tradução.

--overwrite¶: Substitua as traduções existentes ao enviar.

--input¶: Ficheiro a partir do qual o conteúdo é lido, se não for especificado é lido de stdin (entrada predefinida).

--method¶: Método de envio para usar, veja Métodos de importação.

--fuzzy¶: Processamento de cadeia aproximadas (marcados para edição) (vazio, process, approve)

--author-name¶: Nome do autor, para substituir o utilizador atualmente autenticado

--author-email¶: E-mail do autor, para substituir o utilizador atualmente autenticado

Dica

Pode obter informações mais detalhadas sobre como invocar comandos individuais a passar --help, por exemplo: wlc ls --help.

Ficheiros de configuração¶

.weblate, .weblate.ini, weblate.ini: Por ficheiro de configuração de projeto
C:\Users\NAME\AppData\weblate.ini: Ficheiro de configuração do utilizador no Windows.
~/.config/weblate: Ficheiro de configuração do utilizador
/etc/xdg/weblate: Ficheiro de configuração para todo o sistema

O programa segue a especificação XDG, para que possa ajustar a colocação de ficheiros de configuração por variáveis de ambiente XDG_CONFIG_HOME ou XDG_CONFIG_DIRS. No diretório do Windows APPDATA` é o local preferido para o ficheiro de configuração.

As configurações seguintes podem ser configuradas na secção [weblate] (pode personalizar-lo por --config-section):

key: Chave de API para acessar o Weblate.

url: URL de API do servidor, a predefinição é http://127.0.0.1:8000/api/.

translation: Caminho à tradução predefinida - componente ou projeto.

O ficheiro de configuração é um ficheiro INI, por exemplo:

[weblate]
url = https://hosted.weblate.org/api/
key = APIKEY
translation = weblate/application

Além disso, as chaves de API podem ser armazenadas na secção [keys]:

[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.

Exemplos¶

Imprimir a versão atual do programa:

$ wlc version
version: 0.1

Listar todos os projetos:

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

Enviar ficheiro de tradução:

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

You can also designate what project wlc should work on:

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

Com esta configuração é fácil fazer um commit de alterações pendentes no projeto atual:

$ wlc commit