Skip to main content

auto-i18n-lib

Автоматическая библиотека для перевода интерфейсов без ручного сбора строк.


Что содержит библиотека

  • Класс Translator – публичное API для рендеринга и управления переводом.
  • Воркер – фоновый процесс, который:
    • сканирует указанные файлы и папки (HTML, JS/JSX/TSX, UI-словари),
    • извлекает все тексты интерфейса,
    • переводит их через OpenAI,
    • сохраняет в JSON-кэш,
    • обновляет переводы при изменении кода.
  • Парсеры для HTML, JSX/TSX, UI-словарей (рекурсивный обход).
  • Клиентский рантайм – готовый JavaScript с функциями translateKey() и setLanguage() для динамического перевода DOM.
  • Storage – атомарное управление кэшем и очередями.

Что выполняет библиотека

  • В фоне – автоматически находит все строки в проекте, переводит на целевые языки, поддерживает кэш актуальным.
  • При рендеринге – методы translate_html, translate_dict, translate_key мгновенно отдают готовые переводы из локального кэша (без синхронных вызовов OpenAI).
  • На клиенте – смена языка подгружает новый JSON и перерисовывает интерфейс без перезагрузки страницы.

Быстрый старт

from autoi18n import Translator

t = Translator(
    api_key="YOUR_OPENAI_API_KEY",
    source_lang="ru",
    target_langs=["en", "uk", "az", "tr"],
    # Пути для сканирования
    js_globs=["frontend/src/**/*.{js,jsx,tsx}"],
    html_globs=["templates/**/*.html"],
)

# Запустить воркер (один раз или в фоновом потоке)
t.run_translation_loop(interval=300)  # каждые 5 минут

Методы рендеринга

Метод Назначение
translate_html(html, target_lang, page_name) Переводит готовый HTML (текст и атрибуты).
translate_dict(page_name, dict_name, source_dict, target_lang) Переводит вложенный словарь (UI).
translate_key(key, lang, default, dict_name) Возвращает перевод бэкенд-фразы по ключу.
register_keys(items, dict_name) Регистрирует исходные бэкенд-фразы.
build_frontend_runtime(lang) Генерирует JS-рантайм для клиента.

Пример интеграции с React

  1. Настройте Translator с путями к вашему фронтенду.

  2. Запустите воркер – он сам найдёт все строки в компонентах (включая JSX-тексты, атрибуты, вызовы t()).

  3. Вставьте сгенерированный рантайм в index.html:

    <script>
    // Результат t.build_frontend_runtime('ru')
    </script>
    
  4. В компонентах используйте:

    // Любой текст, обёрнутый в translateKey, будет автоматически переведён
    <h1>{window.autoI18n.translateKey('dashboard_welcome', 'Добро пожаловать')}</h1>
    

    Или атрибут data-i18n="dashboard_welcome" на любом элементе.

  5. Переключение языка:

    window.autoI18n.setLanguage('en');
    

Переменные окружения

Переменная Описание
OPENAI_API_KEY Обязательный API‑ключ
SOURCE_LANG Исходный язык (по умолчанию ru)
AUTO_I18N_TARGET_LANGS Целевые языки через запятую
AUTO_I18N_JS_GLOBS Glob-паттерны для JS/JSX (JSON-массив)
AUTO_I18N_HTML_GLOBS Glob-паттерны для HTML
AUTO_I18N_CACHE_DIR Папка для кэша (по умолчанию ./cache)
AUTO_I18N_DYNAMIC_DOM_ENABLED Включить MutationObserver

Требования к доработке (ТЗ)

Чтобы библиотека работала полностью автоматически, необходимо:

  1. Улучшенный JSX-парсер – должен находить все текстовые узлы в JSX, атрибуты (label, placeholder, title, aria-label), вызовы t() и translateKey() в любом синтаксисе (включая шаблонные строки и переменные).
  2. Автоматическое обновление переводов – воркер должен пересканивать файлы при их изменении (watch mode) и переводить только новые/изменённые строки.
  3. Клиентский рантайм – должен уметь подгружать переводы по требованию (lazy loading) и работать с React без дополнительных обёрток.
  4. Поддержка динамических атрибутовdata-i18n должен работать для любых атрибутов, а не только для текста.

Лицензия

MIT

Release files for auto-i18n-lib 1.1.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for auto-i18n-lib 1.1.8
File Size Uploaded
auto_i18n_lib-1.1.8.tar.gz 23.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for auto-i18n-lib 1.1.8
File Interpreter ABI Platform
auto_i18n_lib-1.1.8-py3-none-any.whl Python 3 none any Details

Total release size: 51.5 kB

Release files / auto_i18n_lib-1.1.8.tar.gz

Download URL auto_i18n_lib-1.1.8.tar.gz
Size 23.3 kB
Tags Source
SHA-256 checksum
How to use checksums
604833283c5f660191653eca1fd5d21654701414a01038b8daceb951f3f229e4
BLAKE2b-256 checksum
How to use checksums
73fce4aaad508a0951995ca70acb763e6d439c0f15e11bb2ce11a7d10aa5a32c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.0

Release files / auto_i18n_lib-1.1.8-py3-none-any.whl

Download URL auto_i18n_lib-1.1.8-py3-none-any.whl
Size 28.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5cd5c426c2627bc33e6d1471a06c2536ea533225360464d7ab54c321a8556892
BLAKE2b-256 checksum
How to use checksums
6d5ceb6aea76cd9185bdc72b12694789adcd80e7bae2095c3b5b221a5b349dc2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.0

Release history Release notifications | RSS feed

2.1.1

2 release files

2.0.9

2 release files

2.0.8

2 release files

2.0.7

2 release files

2.0.6

2 release files

2.0.5

2 release files

2.0.4

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

1.2.0

2 release files

1.1.9

2 release files

This release

1.1.8 This release

2 release files

1.1.7

2 release files

1.1.6

2 release files

1.1.5

2 release files

1.1.4

2 release files

1.1.3

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page