README.md

Lokalise API v2 official Python interface

Official Python 3 interface for the Lokalise APIv2 that represents returned data as Python objects.

Quick start

This plugin requires Python 3.8 and above. Install it:

pip install python-lokalise-api

Obtain a Lokalise API token (in your Personal profile) and use it:

import lokalise
client = lokalise.Client('YOUR_API_TOKEN')
project = client.project('123.abc')
print(project.name)

client.upload_file(project.project_id, {
    "data": 'ZnI6DQogIHRlc3Q6IHRyYW5zbGF0aW9u',
    "filename": 'python_upload.yml',
    "lang_iso": 'en'
})

translation_keys = client.keys(project.project_id, {"page": 2,
    "limit": 3,
    "disable_references": "1"})
translation_keys.items[0].key_name['web'] # => "sign_up"

You can also use OAuth 2 tokens:

client = lokalise.OAuthClient('YOUR_OAUTH2_API_TOKEN')

project = client.project('123.abc')

Documentation

Find detailed documentation at python-lokalise-api.readthedocs.io.

License

This plugin is licensed under the BSD 3 Clause License.

Copyright (c) Lokalise group and Ilya Krukowski