Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.84 KB

README.md

File metadata and controls

38 lines (26 loc) · 1.84 KB
Raw

localizeit

localizeit is a command line tool to generate localization files for iOS™ and Android™ projects from Google Spreadsheets™.

Install

Clone the repository and place the localize.py script where you want.

You will need to provide the localizeit.json configuration file with a client ID and client SECRET.
You can create an new project at this url https://console.developers.google.com/project.
Once created, click on your project name and go to APIS & AUTH => Credentials => Create new Client ID.
Select "Installed application" for the APPLICATION TYPE and "Other" for the INSTALLED APPLICATION TYPE.

Create a file named localizeit.json with the following structure:

{  
	"client_id": "42.apps.googleusercontent.com",  
	"client_secret": "ABCDEFGH"  
}

Basic Usage

python localizeit.py generate (android|ios) -s "Your i18n Google Spreadsheet" -o <output_dir>

The script uses OAuth 2 to get authorization to access to your Google Spreadsheet. This is why the first time you launch the script you will be prompted (in a browser) to authorize the app you created in the Google Console. Once you accept the script goes on. The next time you launch the script your credentials are retrieved from a file named .localizeit.storage. The credentials are automatically refreshed if they have expired. Note that you can safely delete this file and you will be prompted again to authorize the app.

Google Spreadsheet Format

The format of the spreadsheet is currently fixed.
Here is the column format:
iOS KEY | Android KEY | iOS Comment | Android Comment | FR | EN | ES

TODO

  • Add an action to create the localizeit.json file
  • Automatically detects language columns in the Google Spreadsheet
  • Handle region specific localization (en_GB, etc)
  • Handle plural forms (Don't know yet if this requires more work or not)