@@ -63,13 +78,15 @@
- [Script Installation](#script-installation)
- [Package Installation](#package-installation)
- [Usage](#usage)
- - [Run the Program](#run-the-program)
+ - [Running the Program](#running-the-program)
- [Script Flags](#script-flags)
- - [Use the Package in Your Project](#use-the-package-in-your-project)
- - [Generate a Spreadsheet in Google Sheets](#generate-a-spreadsheet-in-google-sheets)
+ - [Using the Package in Your Project](#using-the-package-in-your-project)
+ - [Generating a Spreadsheet in Google Sheets](#generating-a-spreadsheet-in-google-sheets)
+ - [Setting Up a Google Account](#setting-up-a-google-account)
+ - [Using the `to_google_sheets` Function in Your Project](#using-the-to_google_sheets-function-in-your-project)
- [Notes](#notes)
- - [Indic Languages Supported by PDF files](#indic-languages-supported-by-pdf-files)
- - [Languages Not Supported by PDF files](#languages-not-supported-by-pdf-files)
+ - [Indic Languages Supported by PDF Files](#indic-languages-supported-by-pdf-files)
+ - [Languages Not Supported by PDF Files](#languages-not-supported-by-pdf-files)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
@@ -81,10 +98,11 @@
## About the Project
-I tried to do the whole process of converting a strings resource file into a spreadsheet in Google Sheets by hand and, even though you can do it with the option **Data > Split text to columns**,
-it involves wasting your time generating the spreadsheet manually. Due to that, I decided to build a time-efficient solution, which consists on running a Python script in order to achieve that with any file type.
+I have tried to do the whole process of converting a strings resource file into a spreadsheet in Google Sheets by hand, and although you can do it with the **Data > Split text to columns** option,
+it is a waste of time to generate the spreadsheet manually. Also, you are limited to spreadsheet files only. For this reason, I decided to create a time-efficient solution that consists of running
+a Python script in order to do this that with any file type.
-Moreover, not only this script can be executed on its own, it also can be installed as a package via **PyPI** (more information [here](#using-the-package-in-your-project) about how to install it).
+In addition to being able to run this script on its own, it can also be installed as a package via **PyPI** (more information on how to install it [here](#use-the-package-in-your-project)).
@@ -172,16 +190,16 @@ Moreover, not only this script can be executed on its own, it also can be instal
└───tests
│ base_tests.py
│ test_get_strings.py
- │ test_to_android.py
- │ test_to_csv.py
- │ test_to_html.py
- │ test_to_ios.py
- │ test_to_json.py
- │ test_to_md.py
- │ test_to_ods.py
- │ test_to_pdf.py
- │ test_to_xlsx.py
- │ test_to_yaml.py
+ │ test_android.py
+ │ test_csv.py
+ │ test_html.py
+ │ test_ios.py
+ │ test_json.py
+ │ test_md.py
+ │ test_ods.py
+ │ test_pdf.py
+ │ test_xlsx.py
+ │ test_yaml.py
│
└───files
├───input
@@ -244,7 +262,7 @@ Moreover, not only this script can be executed on its own, it also can be instal
### Script Installation
-1. Download the [release](#release-files) that is best suited to your needs.
+1. Download the `.zip` file from the [latest release](#release-files).
2. (Optional but recommended) Create a Python virtual environment in the project root. If you're using `virtualenv`, you would run `virtualenv venv`.
3. (Optional but recommended) Activate the virtual environment:
```bash
@@ -269,31 +287,38 @@ Install the PyPI package by running `pip install mobile-strings-converter`.
## Usage
-### Run the Program
+### Running the Program
-For a basic usage, you can run the following command:
+For basic use, you can run the following command:
-```
+```bash
python path/to/mobile_strings_converter.py *.[SUPPORTED_FILE_TYPE] -o *.[SUPPORTED_FILE_TYPE]
```
-See [Generate a Spreadsheet in Google Sheets](#generate-a-spreadsheet-in-google-sheets) to create a spreadsheet.
+To include the comments of the `.xml`/`.strings` file in the output file, add the `-p` (also `--print-comments`) flag:
+
+```bash
+python path/to/mobile_strings_converter.py *.[SUPPORTED_FILE_TYPE] -o *.[SUPPORTED_FILE_TYPE] -p
+```
+
+See the [Generating a Spreadsheet in Google Sheets](#generating-a-spreadsheet-in-google-sheets) section to create a spreadsheet in your Google account.
#### Script Flags
-| Flag | Description |
-|:----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `-h` or `--help` | Displays help text for the program |
-| `-o` or `--output-filepath` | Specifies the filepath for storing the converted file. The file extension can be chosen from the list of supported file types mentioned [here](#about-the-project). |
-| `-g` or `--google-sheets` | Followed by the name of the sheet, creates a new Google Sheets spreadsheet with the specified name. |
-| `-c` or `--credentials` | Followed by the path to your `service_account.json` file is mandatory if you want to generate a spreadsheet in your Google account. |
-| `-p` or `--print-comments` | The output file will include any commented strings present in the original file. |
+| Flag | Description |
+|:----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `-h` or `--help` | Displays help text for the program |
+| `-o` or `--output-filepath` | Specifies the filepath for storing the converted file. The file extension can be chosen from the list of supported file types mentioned [here](#about-the-project). |
+| `-g` or `--google-sheets` | Followed by the name of the sheet, creates a new Google Sheets spreadsheet with the specified name. |
+| `-c` or `--credentials` | Followed by the path to your `service_account.json` file is mandatory if you want to generate a spreadsheet in your Google account. |
+| `-p` or `--print-comments` | The output file will contain all commented strings that were present in the original file (only applicable if the input file is a `.xml` or `.strings` file). Otherwise it will be ignored. |
+ 
