Skip to content

Commit

Permalink
mod readme and simplify option keywords
Browse files Browse the repository at this point in the history
  • Loading branch information
@metasmile
metasmile committed Dec 8, 2017
1 parent fc2b903 commit 9eaf883
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 43 deletions.
62 changes: 24 additions & 38 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
[AD] Meet our app using stringsync, Elie - Your next mobile photography assistant. http://elie.camera
[AD] Meet our app using stringsync, Elie - Your next mobile photography assistant. http://elie.cam

![](https://cdn.rawgit.com/metasmile/strsync/master/logo_1_3.svg)

[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/vsouza/awesome-ios#localization)
[![PyPI version](https://badge.fury.io/py/strsync.svg)](https://badge.fury.io/py/strsync)
[![License](https://img.shields.io/pypi/l/strsync.svg)](http://img.shields.io/badge/license-MIT-lightgrey.svg?style=flat)

Automatically translate and synchronize '.strings' files from defined base language.
Automatically translate and synchronize '.strings' files from the defined base language.

The basic concept of this python CLI tool is very simple file name based one-way synchronizer. If you are running, other localized resources will have exactly the same key with automatically translated strings. Of course, string on the key that already exists will not be modified at all.
The basic concept of this python CLI tool is straightforward file name based one-way synchronizer. If you are running, other localized resources will have the same key with automatically translated strings. Of course, string on the key that already exists will not be modified at all.

While the actual i18n work, my biggest desire was to just quickly fill many empty strings first. This tool has been made for that purpose. In a normal project, automatic translation is sufficient. Because They are always simple sentences. Yes, No, Do it, Not agree, etc.. As you know all translation results of this tool is just based on the Microsoft Translator. So In case of more complex, inspections by human will be required for exact results. But you may save very much of your time!
While the actual i18n work, my biggest desire was to just quickly fill many empty strings first. This tool has been made for that purpose. In a normal project, automatic translation is sufficient. Because They are always simple sentences. Yes, No, Do it, Not agree, etc.. As you know all translation results of this tool is just based on the Google Translator. Stringsync uses unofficial google ajax translation APIs. So no account and API key is required. And please note that, in case of more complex, inspections by human will be required for exact results. But you may save very much of your time!

![](https://github.com/metasmile/strsync/blob/master/structure.png)

Expand All @@ -21,10 +21,6 @@ While the actual i18n work, my biggest desire was to just quickly fill many empt
pip install strsync
```

#### Getting your client id/secret id to use Microsoft Translation API

Try accordance with [this explanation](https://msdn.microsoft.com/en-us/library/mt146806.aspx)

#### Update Python SSL packages if needed

this is not required for python-2.7.9+
Expand All @@ -38,76 +34,66 @@ pip install requests[security]
Naturally, this tool follow [standard ISO639 1~2 codes](http://www.loc.gov/standards/iso639-2/php/English_list.php) or [apple's official document](https://developer.apple.com/library/ios/documentation/MacOSX/Conceptual/BPInternational/LanguageandLocaleIDs/LanguageandLocaleIDs.html) or [this tsv table](https://github.com/metasmile/strsync/blob/master/strsync/lc_ios9.tsv)

```
usage: strsync [-h] [-b BASE_LANG_NAME]
[-x [EXCLUDING_LANG_NAMES ...]] -c
CLIENT_ID -s CLIENT_SECRET
[-f [FORCE_TRANSLATE_KEYS ...]]
[target path]
usage: strsync <target localization resource path>
Automatically translate and synchronize .strings files from defined base
language.
Automatically translate and synchronize .strings files from defined base language.
positional arguments:
target path Target localizable resource path. (root path of
target path Target localization resource path. (root path of
Base.lproj, default=./)
optional arguments:
-h, --help show this help message and exit
-b BASE_LANG_NAME, --base-lang-name BASE_LANG_NAME
-b, --base-lang-name BASE_LANG_NAME
A base(or source) localizable resource
name.(default='Base'), (e.g. "Base" via 'Base.lproj',
"en" via 'en.lproj')
-x [EXCLUDING_LANG_NAMES ...], --excluding-lang-names [EXCLUDING_LANG_NAMES ...]
-x, --excluding-lang-names [EXCLUDING_LANG_NAMES ...]
A localizable resource name that you want to exclude.
(e.g. "Base" via 'Base.lproj', "en" via 'en.lproj')
-c CLIENT_ID, --client-id CLIENT_ID
Client ID for MS Translation API
-s CLIENT_SECRET, --client-secret CLIENT_SECRET
Client Secret key for MS Translation API
-f [FORCE_TRANSLATE_KEYS ...], --force-translate-keys [FORCE_TRANSLATE_KEYS ...]
-f, --force-translate-keys [FORCE_TRANSLATE_KEYS ...]
Keys in the strings to update and translate by force.
-fb [FOLLOWING_BASE_KEYS ...], --following-base-keys [FOLLOWING_BASE_KEYS ...]
-o, --following-base-keys [FOLLOWING_BASE_KEYS ...]
Keys in the strings to follow from "Base".
-fbl [FOLLOWING_BASE_KEYS_IF_LENGTH_LONGER ...], --following-base-keys-if-length-longer
-l, --following-base-keys-if-length-longer
Keys in the strings to follow from "Base"
if its length longer than length of "Base" value.
-ic [IGNORE_COMMENTS ...], --ignore-comments
Allows to ignore comment synchronization.
if its length longer than the length of "Base" value.
-c, --ignore-comments
Allows ignoring comment synchronization.
-v, --verify-results [VERIFY_RESULTS [VERIFY_RESULTS ...]]
Verify translated results via reversed results
-iuv, --ignore-unverified-results [IGNORE_UNVERIFIED_RESULTS [IGNORE_UNVERIFIED_RESULTS ...]]
Allows to ignore unverified results when append them.
-i, --ignore-unverified-results [IGNORE_UNVERIFIED_RESULTS [IGNORE_UNVERIFIED_RESULTS ...]]
Allows ignoring unverified results when appending them.
```

### Examples to use
```
$ strsync -c clien_idXXXX -s clien_secretXXXX
~/Documents/myapp/myapp/Resources/Localizations$ strsync
```

Define specific path you want.
```
$ strsync ./myXcodeProj/Resources/Localizations -c clien_idXXXX -s clien_secretXXXX
$ strsync ./myapp/Resources/Localizations
```

Excluding japanese, spanish, finnish
```
$ strsync ./myXcodeProj/Resources/Localizations -c clien_idXXXX -s clien_secretXXXX -x ja es fi
$ strsync ./myapp/Resources/Localizations -x ja es fi
```

Forcefully translate and update by specific keys you want.
```
$ strsync -c clien_idXXXX -s clien_secretXXXX -f Common.OK Common.Undo "Key name which contains white space"
$ strsync -f Common.OK Common.Undo "Key name which contains white space"
```

Forcefully translate and update by All keys.
```
$ strsync -c clien_idXXXX -s clien_secretXXXX -f (input nothing)
$ strsync -f (input nothing)
```

When you want to accept the values in the 'Base'.
```
$ strsync -c clien_idXXXX -s clien_secretXXXX -fb autoenhance flashmode
$ strsync -o autoenhance flashmode
#before
"flashmode" = "وضع الفلاش";
Expand All @@ -123,7 +109,7 @@ $ strsync -c clien_idXXXX -s clien_secretXXXX -fb autoenhance flashmode
```

If you add an option **-v** or **--verify-results**,
String similarity of the reversed translation result for each languages will be displayed.
String similarity of the reversed translation result for each language will be displayed.

```
$ strsync (...) -v
Expand Down
10 changes: 5 additions & 5 deletions strsync/strsync.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ def main():
parser.add_argument('-b','--base-lang-name', help='A base(or source) localizable resource name.(default=\'Base\'), (e.g. "Base" via \'Base.lproj\', "en" via \'en.lproj\')', default='Base', required=False)
parser.add_argument('-x','--excluding-lang-names', type=str, help='A localizable resource name that you want to exclude. (e.g. "Base" via \'Base.lproj\', "en" via \'en.lproj\')', default=[], required=False, nargs='+')
parser.add_argument('-f','--force-translate-keys', type=str, help='Keys in the strings to update and translate by force. (input nothing for all keys.)', default=[], required=False, nargs='*')
parser.add_argument('-fb','--following-base-keys', type=str, help='Keys in the strings to follow from "Base".', default=[], required=False, nargs='+')
parser.add_argument('-fbl','--following-base-keys-if-length-longer', type=str, help='Keys in the strings to follow from "Base" if its length longer than length of "Base" value.', default=[], required=False, nargs='+')
parser.add_argument('-ic','--ignore-comments', help='Allows to ignore comment synchronization.', default=None, required=False, nargs='*')
parser.add_argument('-o','--following-base-keys', type=str, help='Keys in the strings to follow from "Base.', default=[], required=False, nargs='+')
parser.add_argument('-l','--following-base-keys-if-length-longer', type=str, help='Keys in the strings to follow from "Base" if its length longer than length of "Base" value.', default=[], required=False, nargs='+')
parser.add_argument('-c','--ignore-comments', help='Allows ignoring comment synchronization.', default=None, required=False, nargs='*')
parser.add_argument('-v','--verify-results', help='Verify translated results via reversed results', default=None, required=False, nargs='*')
parser.add_argument('-iuv','--ignore-unverified-results', help='Allows to ignore unverified results when append them.', default=None, required=False, nargs='*')
parser.add_argument('target path', help='Target localizable resource path. (root path of Base.lproj, default=./)', default='./', nargs='?')
parser.add_argument('-i','--ignore-unverified-results', help='Allows ignoring unverified results when appending them.', default=None, required=False, nargs='*')
parser.add_argument('target path', help='Target localization resource path. (root path of Base.lproj, default=./)', default='./', nargs='?')
args = vars(parser.parse_args())

reload(sys)
Expand Down

0 comments on commit 9eaf883

Please sign in to comment.