Update docs

KnugiHK · Oct 24, 2024 · af33078 · af33078
1 parent 9b34f7e
commit af33078
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -130,14 +130,12 @@ After extracting, you will get these:
 Invoke the wtsexporter with --help option will show you all options available.
 ```sh
 > wtsexporter --help
-usage: wtsexporter [-h] [-a] [-i] [-e EXPORTED] [-w WA] [-m MEDIA] [-b BACKUP] [-o OUTPUT] [-j [JSON]] [-d DB]
-                   [-k KEY] [-t TEMPLATE] [-s] [-c] [--offline OFFLINE] [--size [SIZE]] [--no-html] [--check-update]
-                   [--assume-first-as-me] [--no-avatar] [--import] [--business] [--preserve-timestamp] [--wab WAB]
-                   [--time-offset {-12 to 14}] [--date DATE] [--date-format FORMAT] [--include [phone number ...]]
-                   [--exclude [phone number ...]] [--create-separated-media]
+usage: wtsexporter [-h] [-a] [-i] [-e EXPORTED] [-w WA] [-m MEDIA] [-b BACKUP] [-o OUTPUT] [-j [JSON]] [--avoid-encoding-json] [--pretty-print-json [PRETTY_PRINT_JSON]] [-d DB] [-k KEY] [-t TEMPLATE] [-s]
+                   [-c] [--offline OFFLINE] [--size [SIZE]] [--no-html] [--check-update] [--assume-first-as-me] [--no-avatar] [--import] [--business] [--wab WAB] [--time-offset {-12 to 14}] [--date DATE]
+                   [--date-format FORMAT] [--include [phone number ...]] [--exclude [phone number ...]] [--dont-filter-empty] [--per-chat] [--create-separated-media] [--decrypt-chunk-size DECRYPT_CHUNK_SIZE]
+                   [--enrich-from-vcards ENRICH_FROM_VCARDS] [--default-country-code DEFAULT_CONTRY_CODE] [--txt [TEXT_FORMAT]]
 
-A customizable Android and iPhone WhatsApp database parser that will give you the history of your WhatsApp
-conversations in HTML and JSON. Android Backup Crypt12, Crypt14 and Crypt15 supported.
+A customizable Android and iOS/iPadOS WhatsApp database parser that will give you the history of your WhatsApp conversations in HTML and JSON. Android Backup Crypt12, Crypt14 and Crypt15 supported.
 
 options:
   -h, --help            show this help message and exit
@@ -149,11 +147,15 @@ options:
   -m MEDIA, --media MEDIA
                         Path to WhatsApp media folder (default: WhatsApp)
   -b BACKUP, --backup BACKUP
-                        Path to Android (must be used together with -k)/iPhone WhatsApp backup
+                        Path to Android (must be used together with -k)/iOS WhatsApp backup
   -o OUTPUT, --output OUTPUT
                         Output to specific directory (default: result)
   -j [JSON], --json [JSON]
                         Save the result to a single JSON file (default if present: result.json)
+  --avoid-encoding-json
+                        Don't encode non-ascii characters in the output JSON files
+  --pretty-print-json [PRETTY_PRINT_JSON]
+                        Pretty print the output JSON.
   -d DB, --db DB        Path to database file (default: msgstore.db/7c7fba66680ef796b916b067077cc246adacf01d)
   -k KEY, --key KEY     Path to key file
   -t TEMPLATE, --template TEMPLATE
@@ -169,7 +171,6 @@ options:
   --no-avatar           Do not render avatar in HTML output
   --import              Import JSON file and convert to HTML output
   --business            Use Whatsapp Business default files (iOS only)
-  --preserve-timestamp  Preserve the modification timestamp of the extracted files (iOS only)
   --wab WAB, --wa-backup WAB
                         Path to contact database in crypt15 format
   --time-offset {-12 to 14}
@@ -180,11 +181,20 @@ options:
                         Include chats that match the supplied phone number
   --exclude [phone number ...]
                         Exclude chats that match the supplied phone number
+  --dont-filter-empty   By default, the exporter will not render chats with no valid message. Setting this flag will cause the exporter to render those.
+  --per-chat            Output the JSON file per chat
   --create-separated-media
-                        Create a copy of the media seperated per chat in <MEDIA>/separated/ directory 
-                        (Android only)
-
-WhatsApp Chat Exporter: 0.10.0 Licensed with MIT
+                        Create a copy of the media seperated per chat in <MEDIA>/separated/ directory
+  --decrypt-chunk-size DECRYPT_CHUNK_SIZE
+                        Specify the chunk size for decrypting iOS backup, which may affect the decryption speed.
+  --enrich-from-vcards ENRICH_FROM_VCARDS
+                        Path to an exported vcf file from Google contacts export. Add names missing from WhatsApp's default database
+  --default-country-code DEFAULT_CONTRY_CODE
+                        Use with --enrich-from-vcards. When numbers in the vcf file does not have a country code, this will be used. 1 is for US, 66 for Thailand etc. Most likely use the number of your own
+                        country
+  --txt [TEXT_FORMAT]   Export chats in text format similar to what WhatsApp officially provided (default if present: result/)
+
+WhatsApp Chat Exporter: 0.10.5 Licensed with MIT. See https://wts.knugi.dev/docs?dest=osl for all open source licenses.
 ```
 
 # To do

diff --git a/Whatsapp_Chat_Exporter/__main__.py b/Whatsapp_Chat_Exporter/__main__.py
@@ -33,7 +33,7 @@ def main():
         description = 'A customizable Android and iOS/iPadOS WhatsApp database parser that '
                       'will give you the history of your WhatsApp conversations in HTML '
                       'and JSON. Android Backup Crypt12, Crypt14 and Crypt15 supported.',
-        epilog = f'WhatsApp Chat Exporter: {__version__} Licensed with MIT. See'
+        epilog = f'WhatsApp Chat Exporter: {__version__} Licensed with MIT. See '
                   'https://wts.knugi.dev/docs?dest=osl for all open source licenses.'
     )
     parser.add_argument(