Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/backist/qautolinguist
Automatic translation to internationalize QT proyects though a simple CLI.
https://github.com/backist/qautolinguist
cli developer-tools i10n i18n-tool pyqt pyqt5 pyside pyside2 python python3 qt qt-framework qt-linguist qt4 qt5 tools translation
Last synced: 5 days ago
JSON representation
Automatic translation to internationalize QT proyects though a simple CLI.
- Host: GitHub
- URL: https://github.com/backist/qautolinguist
- Owner: Backist
- License: apache-2.0
- Created: 2023-12-16T20:02:59.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-02-01T18:50:02.000Z (8 months ago)
- Last Synced: 2024-09-28T07:40:12.421Z (5 days ago)
- Topics: cli, developer-tools, i10n, i18n-tool, pyqt, pyqt5, pyside, pyside2, python, python3, qt, qt-framework, qt-linguist, qt4, qt5, tools, translation
- Language: Python
- Homepage: https://bit.ly/QAutoLinguist
- Size: 78.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
_Hey Buddy, this README is fine, but check our new docs 👓 👀_
_This project uses [semantic versioning](https://semver.org/)_
📖 **README version:** _0.1.1_
# 🏷️ QAutoLinguist
QAutoLinguist is a CLI with the aim to **automate**, **manage** and **facilitate** the process of internationalising a _Qt_ application through a simple CLI.
QAutoLinguist offers a simple and user-friendly approach to translate your application into other languages automatically using the ``Google Translator API`` by default.
> [!IMPORTANT]
> QAutoLinguist is only functional in `Qt-6.x.x` versions for now.
### Why use QAutoLinguist and not Qt Linguist?
The Qt development environment offers a tool designed to facilitate the translation of Qt applications that use the Qt internationalisation system (i18n)
internationalisation system, [Qt Linguist](https://doc.qt.io/qt-5/qtlinguist-index.html), which provides a GUI for performing translations.
In many occasions, using this tool provided by Qt may be a very professional or complex option, needing some experience or docs to use,
as it is a highly customisable program with various parameters and can be a somewhat tedious option for small to medium sized projects that are simply
small or medium-sized projects that simply want to be able to simply translate their application into other languages.
## 💡 When to use QAutoLinguist:
- [x] Fast internationalisation for any language in the world (133 available) quickly and without performing any tasks.
- [x] Compatible with the entire ``Qt`` environment.
- [x] No previous experience or documentation required.
- [x] Ability to use your favourite translator, such as ``Deepl``, ``Microsoft Translator`` or ``MyMemory Translator`` to perform your translations automatically. *2
- [x] Region support.
- [x] Review and modification of translations before compilation.
- [ ] *Guarantees (partially) accurated translations.
- [ ] Need to work with translation files other than ``.ts``.
- [ ] Supports disambiguation
- [ ] Plurality and gender management
- [ ] Supports context editing or modification.
- [ ] Translation suggestions
> __*__ QAutoLinguist gives the possibility to modify the automatic translations before they are compiled.
> __*2__ Some may require API KEY to work.
> [!NOTE]
> QAutoLinguist is not a professional solution or intended to provide all the flexibility and customisation that Qt Linguist can offer.
> If your Qt application requires contextualisation, plural translations or disambiguations, it is recommended that you use the tool provided by Qt.
## ⚙️ How QAutoLinguist do the process
Regarding the automation process, as a summary, it creates the translation files ``.ts`` for each language and from them the fonts are extracted to introduce them
in a more user-friendly syntax file, ``TOML``, created with the intention of providing the user with a view of the source and the translation made by the user.
files with a more user-friendly syntax, ``TOML``, created with the intention of providing the user with a view of the source and the translation made by
the third-party translator so that the translations, despite being automatic, are as accurate as possible.
Once the sources are translated, they are extracted from the ``TOML`` to be inserted into the .ts and compiled into the translation file to be used, the .qm (compiled files).
## 🛠️ Use:
QAutoLinguist is based on a ``.ini`` configuration file where you specify some parameters to tell QAutoLinguist how to manage the translation process.
> [!IMPORTANT]
> We asume that QAutoLinguist is installed in `PATH`, that is what QAutoLinguist will try when installing it. If not, consider add
> the package directory to PATH variable.
In general cases this is what you are looking for:
1. **Initialize the configuration file**:
This command will create a configuration file in the command run CWD with the name ``.qal_config.ini`` by default, unless ``[]``
is specified.
```bash
>>> qautolinguist build init [] # UNIX
>>> python3 -m qautolinguist build init [] # POSIX
```
2. **Complete the configuration file**:
Once the configuration file is created, fill in the required parameters to perform the translations.
3. **Create the build**:
Once the configuration file is correctly filled in, the only thing left to do is to start the translation process.
Specify ``[]`` if you are in a different directory than the one used to create the configuration file or you have set a different name than the default one.
```bash
>>> qautolinguist build run [] # UNIX
>>> python3 -m qautolinguist build run [] # POSIX
```
## Rebuilds and Isolated cases
#### CASE 1: If you want to change or touch up some translation (.toml files):
- ``Simply recreate the binaries:```
```bash
# If is not specified, CWD will be searched for a TOML file named [.config.toml].
# If the file is missing
>>> qautolinguist rebuild bundles [] # UNIX
>>> python3 -m qautolinguist rebuild bundles [] # POSIX
# if the configuration file is not in the directory where the command is executed, specify its path
```
#### CASE 2: If the application sources have been modified:
- ``You need to create a new build.
Be sure to change the configuration file if you want to change any parameters for this new build.
#### CASE 3: If you want to create a new build for another application:
- ``If a build already exists in the working directory:``` ```.
```bash
>>> qautolinguist build -new [] # windows
CANNOT be the SAME as another config file.
>>> python3 -m qautolinguist build -new [] # linux
```
> [!IMPORTANT]
> Case 3 being developed for now.
## Configuration file
Regarding the ``.qal_config.ini`` that is generated when you run ``**qautotranslator build init**``.
> [!TIP]
> **If you are looking for a quick and easy build, just fill the parameters in section [REQUIRED]**.
It will look something like this:
```ini
# ============================= QAutoLinguist Configuration File =====================================
# This file is auto-generated by qautolinguist.Config .
# If you are not very familiar with the configuration file format,
# just fill in the fields in the "Required" section.
# Be cautious when placing values.
# Take these measures:
# 1. Do not use "" or '' to specify text strings, even if you want to specify paths containing spaces;
# the parser parses them internally; it will cause an error if you do.
# 2. This format uses empty lines to detect braces and attributes.
# If you have to specify multi-line values, increase the indentation for each new line.
# ===============================================================================
[Required]
# File to search the app translation sources.
source_file=
# Reference locale, taken as a reference to make other translations.
default_locale= en
# A list of languages/locales that your application will support.
# Langs or locales can be put either as or typing the lang directly (english, spanish, etc).
available_locales= []
# ============================= OPTIONALS =====================================
# Usually you will not need to edit this section.
# Here you can adjust where the generated files are saved and some settings to
# handle the behaviour of the QAutoLinguist
# ==================================================================================
[Optionals]
# Folder that contains the .qm files (Final translation files). If not specif
# ied, a folder will be created in command CWD
translations_folder=
# Folder that contains the .ts files (Qt translation Files). If not specified
# , a folder will be created in command CWD
source_files_folder=
# Folder that contains the .toml files (editable translation files). If not s
# pecified, a folder will be created in command CWD
translatables_folder=
# When True, translation reference will be used in case one translation in on
# e language fails. When False a FailedTranslation exception will be raised.
use_default_on_failure= true
# Allow seeing and editing translated translations in case you want to modify
# some words or phrases after compiling the files.
revise_after_build= false
# Keep the translations folder and delete the ones created during the build.
# NOTE: The translatable and source_files folders will be deleted. Make sure
# they do not contain valuable or necessary files for your project.
clean= true
# Displays information about the state of the build.
debug_mode= true
# Displays more information about the processes done. DEBUG_MODE must be True
# to enable that option.
verbose= false
```