maint/sync-transifex/README.md

   1 # Translations maintenance
   2
   3 ## Requirements
   4
   5 * tx
   6     - Transifex client
   7     - https://developers.transifex.com/docs/cli
   8 * po4a
   9     - Tool for converting translations between PO and other formats
  10     - https://po4a.org
  11
  12 ## Configuration
  13
  14 First time you run `tx` command it will ask you for your API token and create `~/.transifexrc`.
  15
  16 ## Maintenance
  17
  18 Check the `*-from-transifex.py` (run by hand) and `*-to-transifex.py` (used in CI) scripts.
  19
  20 Wrapper for modern Transifex client:
  21
  22 ```shell
  23 #!/bin/sh
  24
  25 touch ~/.transifexrc
  26
  27 export XUID=$(id -u)
  28 export XGID=$(id -g)
  29
  30 docker run \
  31     --rm -i \
  32     --user $XUID:$XGID \
  33     --volume="/etc/group:/etc/group:ro" \
  34     --volume="/etc/passwd:/etc/passwd:ro" \
  35     --volume="/etc/shadow:/etc/shadow:ro" \
  36     --volume $(pwd):/app \
  37     --volume ~/.transifexrc:/.transifexrc \
  38     --volume /etc/ssl/certs/ca-certificates.crt:/etc/ssl/certs/ca-certificates.crt \
  39     transifex/txcli \
  40     --root-config /.transifexrc \
  41     "$@"
  42 ```