idem-ai 0.1.0

About

idem-ai extends idem, a powerful infrastructure and configuration management tool, by adding translation capabilities from the pop-ml plugin. With idem-ai, you can enable multilingual support in your infrastructure management workflows.

By integrating idem-ai into your idem environment, you gain access to additional contracts and features that enable translation in various aspects of idem. The added contracts from idem-ai provide translation capabilities for logs, state comments, and rend output. This means you can translate log messages, comments within your states, and the rendered output of commands to facilitate communication in multiple languages.

idem-ai also introduces an ml.translate exec module, which allows you to perform on-the-fly translations using pop-ml. This module can be used within Jinja in SLS or invoked directly on the command line, giving you flexibility in translating text in your idem environment.

With idem-ai, you can effortlessly manage multilingual environments, ensuring clear and consistent communication across language barriers in your infrastructure management workflows.

Getting Started

pip install idem-ai

# clone repo
git clone git@gitlab.com/vmware/idem/idem-ai.git
cd idem-ai

# Setup venv
python3 -m venv .venv
source .venv/bin/activate
pip install -e .

Usage

To use idem-ai, you need to create a YAML configuration file that defines the behavior of the translation.

Here’s an example YAML configuration file:

idem:
  translate_output: False
  translate_comments: False
  translate_docs: False
  translate_logs: False
pop_ml:
  source_lang: en
  dest_lang: es

This configuration file contains various options that control the translation behavior:

• translate_output: If set to True, the output of the execution will be translated. Default is False.

• translate_comments: If set to True, the comments of states and exec moduleswill be translated. Default is False.

• translate_logs: If set to True, the log messages will be translated. Default is False.

• dest_lang: The destination language for translation. Default is “es”.

• source_lang: The source language for translation. Default is “en”.

The dest_lang parameter is required for the translation to work. It should be a two-letter language code.

You can modify these options based on your requirements.

idem exec ml.translate "Hello World!" dest_lang=es

idem -c my_config.cfg exec test.ping --translate-logs --log-level=debug

idem -c my_config.cfg state my_state.sls --translate-state-comments

idem -c my_config.cfg exec test.ping --translate-output

idem -c my_config.cfg doc exec.test.ping --translate-docs

Roadmap

Reference the open issues for a list of proposed features (and known issues).

Acknowledgements

• Img Shields for making repository badges easy.