Installation¶

Requirements¶

Python 3.10 or higher
Django 4.2 or higher

Install with uv¶

uv add --dev translatebot-django

Install with Poetry¶

poetry add --group dev translatebot-django

Install with pip¶

pip install translatebot-django

Dev dependency

TranslateBot is a development tool - you only need it when generating translations, not at runtime. Installing it as a dev dependency keeps your production environment lean.

Optional: DeepL Support¶

If you want to use DeepL instead of an LLM provider:

uvPoetrypip

uv add --dev translatebot-django[deepl]

poetry add --group dev translatebot-django[deepl]

pip install translatebot-django[deepl]

Optional: Model Translation Support¶

If you want to translate database model fields using django-modeltranslation:

uvPoetrypip

uv add --dev translatebot-django[modeltranslation]

poetry add --group dev translatebot-django[modeltranslation]

pip install translatebot-django[modeltranslation]

Add to Django¶

Add translatebot_django to your INSTALLED_APPS:

settings.py

INSTALLED_APPS = [
    # ...
    'translatebot_django',
]

For Model Translation

If using django-modeltranslation, add it before django.contrib.admin:

settings.py

INSTALLED_APPS = [
    'modeltranslation',  # Must be before admin
    'django.contrib.admin',
    # ...
    'translatebot_django',
]

Next Steps¶

Continue to the Quick Start Guide to translate your first strings.