First commit

README.md

@@ -1,2 +1,66 @@
 # pinterest-downloader
-Download all high resolution images from board
+Download all images/videos from pinterest user/board/section.
+
+### Some features:
+    - Accept input as /username/, /username/boardname/, /username/boardname/section, 
+    - Accept input as link of /username/, /username/boardname/, /username/boardname/section, and /pin/
+    - High resolution. 
+    - Error tolerance. Try second resolution if first resolution error.
+    - Able download both image and video.
+    - Multi-threads when download images.
+    - Media Filename naming in PinID_Title_Description_[Date].Ext meaningful form. 
+    - Media Filename truncate to fit maximum length automatically.
+    - Log PinID, Title, Description, Link, Metadata, [Date] to log.log file if media filename can't fit.
+    - Unique board/log name with timestamp options.
+
+### Usage:
+
+    $ python3 pinterest-downloader.py --help
+    usage: pinterest-downloader.py [-h] [-d DIR] [-j THREAD_MAX] [-c CUT] [-bt]
+                                  [-lt] [-f]
+                                  path
+
+    Download 🅿️interest board by username, username/boardname,
+    username/boardname/section or link. Support image and video. Filename compose
+    of PinId_Title_Description_Date.Ext. PinId always there while the rest is
+    optional.
+
+    positional arguments:
+      path                  Pinterest username, or username/boardname, or link(
+                            /pin/ may include created time )
+
+    optional arguments:
+      -h, --help            show this help message and exit
+      -d DIR, -dir DIR      Specify folder path/name to store. Default is "images"
+      -j THREAD_MAX, --job THREAD_MAX
+                            Specify maximum threads when downloading images.
+                            Default is number of processors on the machine,
+                            multiplied by 5
+      -c CUT, --cut CUT     Specify maximum length of filename. Default is 255 and
+                            retry with fallback(filename-only) towards 85
+                            automatically. Username or boardname will use this
+                            option too if too long. Minimum 24.
+      -bt, --board-timestamp
+                            Suffix board directory name with unique timestamp
+      -lt, --log-timestamp  Suffix log.log filename with unique timestamp. Default
+                            filename is log.log. Note: Pin id without
+                            Title/Description/Link/Metadata/Created_at will not
+                            write to log.
+      -f, --force           Force re-download even if image already exist
+
+### Example Usage:
+    $ python3 pinterest-downloader.py https://www.pinterest.com/antonellomiglio/computer/ 
+    $ python3 pinterest-downloader.py https://www.pinterest.com/antonellomiglio/computer/ -d comp
+    $ python3 pinterest-downloader.py -d comp https://www.pinterest.com/antonellomiglio/computer/ # or path in last
+    $ python3 pinterest-downloader.py https://www.pinterest.com/antonellomiglio/computer/ -bt -lt -d comp -f
+    $ python3 pinterest-downloader.py https://www.pinterest.com/antonellomiglio/computer/ -c 40 # Default already good enough
+    $ python3 pinterest-downloader.py https://www.pinterest.com/antonellomiglio/computer/ -j 666 # Default already good enough
+
+### Example Output:
+    xb@dnxb:~/Downloads/pinterest/pinterest-downloader$ python3 pinterest-downloader.py -d comp https://www.pinterest.com/antonellomiglio/computer/ 
+    [i] Job is download single board by username/boardname: antonellomiglio/computer
+    [...] Getting all images in this board: computer ... [ 173 / ? ] [➕] Found estimated 196 images
+    [✔] Progress: |##################################################| 100.0% Complete  
+    [i] Time Spent: 0:00:17
+    xb@dnxb:~/Downloads/pinterest/pinterest-downloader$ 
+