Cliente Weblate¶
Novo na versão 2.7: Há suporte total do utilitário wlc desde o Weblate 2.7. Se estiver a usar uma versão mais antiga, algumas incompatibilidades com a API podem ocorrer.
Instalação¶
O cliente Weblate é enviado separadamente e inclui o módulo Python. Para usar os comandos abaixo, precisa instalar wlc
:
pip3 install wlc
Uso do Docker¶
The Weblate Client is also available as a Docker image.
The image is published on Docker Hub: https://hub.docker.com/r/weblate/wlc
Instalar:
docker pull weblate/wlc
The Docker container uses Weblate’s default settings and connects to the API deployed in localhost. The API URL and API_KEY can be configured through the arguments accepted by Weblate.
The command to launch the container uses the following syntax:
docker run --rm weblate/wlc [WLC_ARGS]
Exemplo:
docker run --rm weblate/wlc --url https://hosted.weblate.org/api/ list-projects
Primeiros Passos¶
A configuração do wlc é armazenada em ``~/.config/weblate``(veja Ficheiros de configuração para outros locais), por favor, crie-a para corresponder ao seu ambiente:
[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
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. 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
¶
Novo na versão 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
¶
Novo na versão 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 status do repositório para um determinado objeto do Weblate (tradução, componente ou projeto).
-
statistics
¶
Exibe estatísticas detalhadas para um determinado objeto Weblate (tradução, componente ou projeto).
-
lock-status
¶
Novo na versão 0.5: Suportado desde o wlc 0.5.
Exibe o status do bloqueio.
-
lock
¶
Novo na versão 0.5: Suportado desde o wlc 0.5.
Bloqueia o componente de tradução posterior no Weblate.
-
unlock
¶
Novo na versão 0.5: Suportado desde o wlc 0.5.
Desbloqueia a tradução do componente Weblate.
-
changes
¶
Novo na versão 0.7: Suportado desde o wlc 0.7 e o Weblate 2.10.
Exibe alterações para um determinado objeto.
-
download
¶
Novo na versão 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
¶
Novo na versão 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).
-
Dica
You can get more detailed information on invoking individual commands by
passing --help
, for example: wlc ls --help
.
Ficheiros de configuração¶
.weblate
,.weblate.ini
,weblate.ini
Alterado na versão 1.6: The files with .ini extension are accepted as well.
Por ficheiro de configuração de projeto
C:\Users\NAME\AppData\weblate.ini
Novo na versão 1.6.
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 sendo
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/master
Além disso, as chaves de API podem ser armazenadas na secção [keys]
:
[keys]
https://hosted.weblate.org/api/ = APIKEY
Isso permite que armazene chaves nas suas configurações pessoais, enquanto usa a configuração do .weblate
no repositório VCS para que o wlc saiba com qual servidor ele deve comunicar.
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/
Também pode designar em qual projeto o wlc deve trabalhar:
$ cat .weblate
[weblate]
url = https://hosted.weblate.org/api/
translation = weblate/master
$ wlc show
branch: master
file_format: po
source_language: en
filemask: weblate/locale/*/LC_MESSAGES/django.po
git_export: https://hosted.weblate.org/git/weblate/master/
license: GPL-3.0+
license_url: https://spdx.org/licenses/GPL-3.0+
name: master
new_base: weblate/locale/django.pot
project: weblate
repo: git://github.com/WeblateOrg/weblate.git
slug: master
template:
url: https://hosted.weblate.org/api/components/weblate/master/
vcs: git
web_url: https://hosted.weblate.org/projects/weblate/master/
Com esta configuração é fácil fazer um commit de alterações pendentes no projeto atual:
$ wlc commit