The project is in a healthy, maintained state
Opinionated Ruby client for the Lokalise platform API allowing to work with translations, projects, users and other resources as with Ruby objects.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Dependencies

Development

~> 0.1
~> 2.5
~> 3.10
~> 13.0
~> 3.6
~> 1.6
~> 0.16
~> 6.0

Runtime

 Project Readme

Lokalise API v2 official Ruby interface

Gem Build Status Test Coverage Downloads total

Official opinionated Ruby interface for the Lokalise API that represents returned data as Ruby objects.

Looking for a Rails integration? Try the new lokalise_rails gem.

Quickstart

Install the gem by running:

$ gem install ruby-lokalise-api

Obtain an API token in your personal profile (API tokens section) and initialize the client:

require 'ruby-lokalise-api'

@client = Lokalise.client 'YOUR_TOKEN_HERE'

Now the @client can be used to perform API requests:

project = @client.project '123.abc'
project.name

process = @client.upload_file project_id,
                              data: 'Base-64 encoded data... ZnI6DQogI...',
                              filename: 'my_file.yml',
                              lang_iso: 'en'

process.status

Usage

Detailed documentation can be found at lokalise.github.io/ruby-lokalise-api.

License

This gem is licensed under the BSD 3 Clause license. Prior to version 4 the license type was MIT.

Copyright (c) Lokalise team and Ilya Bodrov