Skip to content

faissaloux/geranslator

Repository files navigation

Logo

Test Python package codecov pre-commit.ci status PyPI PyPI - Python Version PyPI - Status

Installation

    pip install geranslator

Configuration

.geranslator-config.yaml

It's gonna be created for you. 😌

geranslator:
  lang_dir: lang
  lang_files_ext: json
  provider: google
  origin_lang: en
  target_langs: [fr, ar]
  • lang_dir: Where your translation files live.
  • lang_files_ext: Your translation files extension.
  • provider: Provider you want to translate your file.
  • origin_lang: The origin language you already have.
  • target_langs: Languages you want your file to get translated to.

supported extensions: json, yaml, yml, po

supported providers: google, deepl

Usage

CLI

geranslator

Supported options

option short description
--provider -p To specify provider.
--lang-dir -d To specify translation files directory.
--extension -e To specify translation files format.
--origin-lang -o To specify the origin language.
--target-langs -t To specify target languages.
geranslator --provider=deepl --origin-lang=en --target-langs=es,pt
geranslator -p deepl -o en -t es,pt

Note

Keep in mind that default values are on .geranslator-config.yaml

IDE

This will use the configuration as default

    from geranslator import Geranslator

    Geranslator().translate()

You can customize it using the following methods. 😃

    from geranslator import Geranslator

    geranslator = Geranslator()
    geranslator.set_provider('google')
    geranslator.set_lang_dir('translation')
    geranslator.set_origin_lang('en')
    geranslator.set_target_lang(['ar', 'fr'])
    geranslator.set_lang_files_extension('json')
    geranslator.translate()

You can chain them too 😮

    from geranslator import Geranslator

    Geranslator().set_provider('google').set_lang_dir('translation').set_origin_lang('en').set_target_lang(['ar', 'fr']).set_lang_files_extension('json').translate()