A CLI tool for translating .po files using GPT models.
Project description
Python GPT-4 PO File Translator
This Python script provides a convenient tool for translating .po
files using OpenAI's GPT-4 model. It is designed to handle both bulk and individual translation modes, making it suitable for a wide range of project sizes and .po
file structures.
Features
- Bulk Translation Mode: Enhances efficiency by facilitating the translation of multiple text entries simultaneously.
- Individual Translation Mode: Offers the flexibility to translate entries one at a time for greater precision.
- Configurable Batch Size: Allows users to set the number of entries to be translated in each batch during bulk translation.
- Comprehensive Logging: Logs detailed information for progress monitoring and debugging purposes.
- Fuzzy Entry Exclusion: Enables the option to omit 'fuzzy' entries from translation in
.po
files. - Flexible API Key Configuration: Supports providing the OpenAI API key either through command-line arguments or a
.env
file.
Requirements
- Python 3.x
polib
libraryopenai
Python package
API Key Configuration
The gpt-po-translator
supports two methods for providing OpenAI API credentials:
-
Environment Variable: Set your OpenAI API key as an environment variable named
OPENAI_API_KEY
. This method is recommended for security and ease of API key management.export OPENAI_API_KEY='your_api_key_here'
-
Command-Line Argument: Pass the API key as a command-line argument using the
--api_key
option.gpt-po-translator --folder ./locales --lang de,fr --api_key 'your_api_key_here' --bulk --bulksize 100 --folder-language
Ensure your API key is kept secure and not exposed in shared or public spaces.
Installation
Via PyPI
Install the gpt-po-translator
package directly from PyPI:
pip install gpt-po-translator
Manual Installation
For manual installation or to work with the latest code from the repository:
- Clone the repository:
git clone [repository URL]
- Navigate to the cloned directory and install the package:
pip install .
Usage
Use gpt-po-translator
as a command-line tool:
gpt-po-translator --folder [path_to_po_files] --lang [language_codes] [--api_key [your_openai_api_key]] [--fuzzy] [--bulk] [--bulksize [batch_size]] [--folder-language]
Example
gpt-po-translator --folder ./locales --lang de,fr --api_key 'your_api_key_here' --bulk --bulksize 100 --folder-language
This command translates .po
files in the ./locales
folder to German and French, using the provided OpenAI API key, and processes 100 translations per batch in bulk mode.
Logging
The script logs detailed information about the files being processed, the number of translations, and batch details in bulk mode.
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gpt_po_translator-0.1.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de21ddb4997dc11b153dbcbaa8356575cbc6675b9578676aeee0ace2216524fb |
|
MD5 | c6fd9e1a4d39d2225073e657010c6f17 |
|
BLAKE2b-256 | 38b15016b23701bfd0d7c6101cb5f4db1d49c27bceeadc61785097bd4e2c8b42 |