Skip to content

transifex/transifex-client

Repository files navigation

Transifex Command-Line Tool

image image codecov PyPI version

The New Client 🎉

We released a stable version of a new Transifex Client, compatible with the new API, and offered as single executable.

Please start using the new Transifex CLI here , since this software is considered deprecated (as of January 2022) and will sunset on Nov 30, 2022.

Getting started

Whether you have experience with the command line or not, this interactive tutorial is intended for everyone who wishes to learn how the Transifex client works. There is no need to download anything - Just click on the link provided above, and follow the instructions.

For more information about TX client, please visit our documentation guide here.

Description

The Transifex Command-line Tool enables you to manage your translations within a project without the need of an elaborate UI system.

You can use the command line tool to create new resources, map locale files to translations, and synchronize your Transifex project with your local repository. Translators and localization managers can use it to handle large volumes of translation files. The Transifex Command-line Tool can help to enable continuous integration workflows and can be run from CI servers like Jenkins and Bamboo.

Click here for complete documentation on the Transifex Command-line Tool via our documentation site.

Installation

You can install the latest version of transifex-client running pip install transifex-client or easy_install transifex-client.

Build transifex-client for Windows

  1. Download transifex-client sources via git or github archive.

    1. git clone https://github.com/transifex/transifex-client.git
    2. Download and unpack https://github.com/transifex/transifex-client/archive/master.zip
  2. Download and install Python.

    At this step choose the right version of python (2.7, 3.5, 3.6 or 3.7) and x86 or x86-64 instruction set.

    Make sure pip marked for installation(default for latest installers).

  3. Install PyInstaller.

    Suppose that Python installed to C:\\Program Files\\Python35-32

    Make python.exe accessible via PATH environment variable or cd to directory containing python.exe.

    python -m pip install pyinstaller
    

    This command will install PyInstaller package and its dependencies.

  4. Build transifex-client distribution.

    Change directory to transifex-client folder and run command:

    python -m PyInstaller contrib/tx.spec
    # or
    pyinstaller contrib/tx.spec
    
  5. tx.exe

    dist/tx.exe will be created as the result of build process.

Getting Help

You can always get additional help via GitHub issues or Transifex support

License

Transifex Client is primarily distributed under the terms of the GPL License (Version 2.0).

See LICENSE for details.