Skip to main content

Official Python interface for the Lokalise API v2

Project description

Lokalise API v2 official Python interface

PyPI CI Downloads Docs

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

Quick start

This plugin requires Python 3.7 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python_lokalise_api-2.1.0.tar.gz (24.8 kB view hashes)

Uploaded source

Built Distribution

python_lokalise_api-2.1.0-py3-none-any.whl (49.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page