Customizing Weblate

Extend and customize using Django and Python. Contribute your changes upstream so that everybody can benefit. This reduces your maintenance costs; code in Weblate is taken care of when changing internal interfaces or refactoring the code.

Warning

Neither internal interfaces or templates are considered a stable API. Please review your own customizations for every upgrade, the interface or their semantics might change without notice.

Creating a Python module

If you are not familiar with Python, you might want to look into Python For Beginners, explaining the basics and pointing to further tutorials.

To write some custom Python code (called a module), a place to store it is needed, either in the system path (usually something like /usr/lib/python3.7/site-packages/) or in the Weblate directory, which is also added to the interpreter search path.

Better yet, turn your customization into a proper Python package:

  1. Create a folder for your package (we will use weblate_customization).

  2. within it, create a setup.py file to describe the package:

    from setuptools import setup
    
    setup(
        name = "weblate_customization",
        version = "0.0.1",
        author = "Your name",
        author_email = "[email protected]",
        description = "Sample Custom check for Weblate.",
        license = "GPLv3+",
        keywords = "Weblate check example",
        packages=['weblate_customization'],
    )
    
  3. Create a folder for the Python module (also called weblate_customization) for the customization code.

  4. Within it, create a __init__.py file to make sure Python can import the module.

  5. This package can now be installed using pip install -e. More info to be found in “Editable” Installs.

  6. Once installed, the module can be used in the Weblate configuration (for example weblate_customization.checks.FooCheck).

Your module structure should look like this:

weblate_customization
├── setup.py
└── weblate_customization
    ├── __init__.py
    ├── addons.py
    └── checks.py

You can find an example of customizing Weblate at <https://github.com/WeblateOrg/customize-example>, it covers all the topics described below.

Custom quality checks, addons and auto-fixes

To install your code for Custom automatic fixups, Writing own checks or Writing addon and in Weblate:

  1. Place the files in your Python module containing the Weblate customization (see Creating a Python module).

  2. Add its fully-qualified path to the Python class in the dedicated settings (WEBLATE_ADDONS, CHECK_LIST or AUTOFIX_LIST):

# Checks
CHECK_LIST += (
    'weblate_customization.checks.FooCheck',
)

# Autofixes
AUTOFIX_LIST += (
  'weblate_customization.autofix.FooFixer',
)

# Addons
WEBLATE_ADDONS += (
  'weblate_customization.addons.ExamplePreAddon',
)