gslocalization

Localisation iOS et Android à l'aide de feuilles Google

Idée de base

1. Exportez vos fichiers de localisation vers Google Sheets .
2. Traduire les localisations manquantes ou mettre à jour les existantes dans les feuilles de calcul Google .
3. Exécutez à nouveau le script pour importer les localisations à partir de la feuille de calcul dans votre projet .

Installation

Python 2.7 ou de préférence Python 3 doit être installé sur votre machine avec la commande pip également disponible.

Clone le référentiel et exécuter pip install -r requirements.txt .

Autoriser gslocalization avec Google Sheets

1. Obtenez un fichier JSON service account key à partir de votre console de développeur Google
   • Connectez-vous à https://console.developers.google.com
   • Sélectionnez votre projet (ou créez-en un nouveau)
   • Assurez-vous que l' Google Drive API et Google Sheets API sont activées
   • Accédez aux Credentials et à partir du menu Create credentials , sélectionnez Service account key
   • Sélectionnez votre compte de service (ou créez-en un nouveau avec le rôle App Engine Admin )
   • Assurez-vous que JSON est sélectionné dans les options Key type .
   • Cliquez sur Create
   • Un fichier JSON commencera à télécharger. Enregistrez ce fichier et utilisez-le plus tard pour l'authentification.

ios-gslocalisation.py

Usage

python ios-gslocalization.py -x {PATH_TO_XCODEPROJ} -o {XLIFF_OUTPUT_DIR} -a {JSON_AUTH_FILE_PATH} -e {SHARE_EMAIL_ADDRESS} -l {LOCALIZATION_LANGUAGES} -d {DEV_LANGUAGE}

1. PATH_TO_XCODEPROJ - chemin vers votre fichier .xcodeproj
   • Utilisé pour appeler xcodebuild (exportation et localisation d'importation)
   • Les fichiers Xliff générés sont enregistrés sur XLIFF_OUTPUT_DIR
2. XLIFF_OUTPUT_DIR - Répertoire de sortie pour les fichiers xliff générés
3. JSON_AUTH_FILE_PATH - Chemin vers la Service account key Google Sheets
4. SHARE_EMAIL_ADDRESS - l'adresse e-mail pour partager les feuilles de calcul créées
   • Puisque nous utilisons une Service account key , toutes les feuilles de calcul sont créées et détenues par le compte de service (ex. [email protected])
   • Une fois que le compte de service a créé les feuilles de calcul, il transfère la possession de fichier à l'adresse e-mail fournie
   • Fournissez votre adresse e-mail pour être en mesure de visualiser les résultats des feuilles de calcul Google
5. LOCALIZATION_LANGUAGES ​​- une chaîne contenant plusieurs codes de langue utilisés pour la localisation
   • Ex: "Es, Ru, Ja" pour l'espagnol, le russe et le japonais
   • Cela ne permet pas la localisation d'une nouvelle langue dans votre projet Xcode
   • Fournir des langues qui existent déjà dans votre projet
6. DEV_LANGUAGE (facultatif, par défaut en en ) - le code de la langue pour la langue en développement du projet

Notes

• Ce script exporte les localisations actuelles de votre projet à l'aide de xcodebuild .

• Il analyse les fichiers Xliff obtenus et les télécharge sur Google Sheets.

• Il y a une feuille de calcul pour chaque langue, avec le format de nom suivant: {PROJECT_NAME}_{LANGUAGE_NAME}_localizations (ex. MyProject_Spanish_localizations , MyProject_Russian_localizations , etc.). À l'intérieur de chaque feuille de calcul, il y a une feuille de calcul par plate-forme (Ex. ios_strings , android_strings ). Le {PROJECT_NAME} est déduit du nom de fichier xcodeproj .

• Toutes les chaînes sont ajoutées à leur feuille de calcul correspondante, avec l'en-tête suivant:

  Source: SOURCE_LANGUAGE | Target: TARGET_LANGUAGE | Example | Comment | String Key | File Path

  • Source: SOURCE_LANGUAGE = Texte dans la langue source
  • Target: TARGET_LANGUAGE = Texte traduit dans la langue cible
  • Example = vide si la chaîne contient des espaces réservés ( %@, %d, etc. ). C'est un endroit pour fournir un exemple pour les traducteurs.
  • Comment = commentaires NSLocalisedString
  • String Key = l'ID de la chaîne
  • File Path = chemin relatif vers le fichier source de la chaîne (fichier .strings ou .storyboard )

• Après avoir mis à jour la traduction dans Google Sheets, exécutez à nouveau le même script pour importer les nouvelles chaînes dans votre projet XCode.

android-gslocalisation.py

Usage

python android-gslocalization.py -p {PROJECT_NAME} -r {PATH_TO_RES_FOLDER} -a {JSON_AUTH_FILE_PATH} -e {SHARE_EMAIL_ADDRESS} -l {DEVELOPMENT_LANGUAGE}

1. PROJECT_NAME - Nom du projet (utilisé pour préfixer le nom de feuille de calcul)
2. PATH_TO_RES_FOLDER - chemin vers votre dossier Android res
   • regarde ce dossier pour tous les fichiers strings.xml
   • Pour tout fichier strings.xml , la langue cible est détectée par le nom du dossier Parrent (Ex. values-es pour l'espagnol)
3. JSON_AUTH_FILE_PATH - Chemin vers la Service account key Google Sheets
4. SHARE_EMAIL_ADDRESS - l'adresse e-mail pour partager les feuilles de calcul créées
   • Puisque nous utilisons une Service account key , toutes les feuilles de calcul sont créées et détenues par le compte de service (ex. [email protected])
   • Une fois que le compte de service a créé les feuilles de calcul, il transfère la possession de fichier à l'adresse e-mail fournie
   • Fournissez votre adresse e-mail pour être en mesure de visualiser les résultats des feuilles de calcul Google
5. DEVELOPMENT_LANGUAGE - Le code linguistique de votre langue de développement (par défaut = en )

Notes

• Ce script charge tous les fichiers strings.xml dans PATH_TO_RES_FOLDER .

• Il analyse les fichiers XML obtenus et les télécharge sur Google Sheets.

• Il y a une feuille de calcul pour chaque langue, avec le format de nom suivant: {PROJECT_NAME}_{LANGUAGE_NAME}_localizations (ex. MyProject_Spanish_localizations , MyProject_Russian_localizations , etc.). À l'intérieur de chaque feuille de calcul, il y a une feuille de calcul par plate-forme (Ex. ios_strings , android_strings ).

• Toutes les chaînes sont ajoutées à leur feuille de calcul correspondante, avec l'en-tête suivant:

  Source: SOURCE_LANGUAGE | Target: TARGET_LANGUAGE | String ID

  • Source: SOURCE_LANGUAGE = Texte dans la langue source
  • Target: TARGET_LANGUAGE = Texte traduit dans la langue cible
  • String ID = l'ID de la chaîne

• Après avoir mis à jour la traduction dans Google Sheets, exécutez à nouveau le même script pour écraser les fichiers strings.xml dans votre dossier Ressources.

Dépendances

 # parsing arguments
argparse

# provides access to Google Sheets API
pygsheets

# XML parsing for XML/XLIFF files
lxml

# type hinting
typing

# colored output in consolde
colorama

# conversion between language code and language name
langcodes; python_version>'3'
langcodes-py2; python_version<'3'

Conseils généraux

1. Gardez votre projet sous le contrôle source, ce qui vous permet de restaurer vos fichiers de localisation à leur état précédent, au cas où ce script briserait quelque chose.

Conseils iOS

1. Utilisez une valeur par défaut pour les chaînes localisées. Ce faisant, vous aurez la valeur par défaut (généralement la chaîne dans la langue de développement) dans la colonne de la langue source, au lieu de la clé de chaîne.
   • Pour Objective C , utilisez NSLocalizedStringWithDefaultValue(@"KEY", nil, [NSBundle mainBundle], @"DEFAULT_VALUE", @"COMMENT")] au lieu de NSLocalizedString(@"KEY", @"COMMENT")]
   • Pour Swift , utilisez NSLocalizedString("KEY", tableName: nil, bundle: Bundle.main, value: "DEFAULT_VALUE", comment: "COMMENT") au lieu de NSLocalizedString("KEY", comment: "COMMENT")
   • Utilisez ce script Python pour convertir les appels NSLocalizedString pour inclure une valeur par défaut