Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisballinger committed Oct 23, 2013
1 parent 228a701 commit 99ef224
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,29 @@ python-localizable
==================

Localizable.strings parser for Python

# Usage

Install using pip.

$ pip install localizable

You can either parse a full string directly or pass a file path:

import localizable

strings = localizable.parse_strings(filename='Localizable.strings')
strings = localizable.parse_strings(content="content of .strings file") # this works too

The output format is an array of dictionaries, in order, with the following key/value pairs:

/* Comment */
"Key" = "Value";

* `key`: "Key"
* `value`: "Value"
* `comment`: "Comment"

# License

GPLv2. Adapted from Transifex.

0 comments on commit 99ef224

Please sign in to comment.