add compressing/decompressing files tutorial

Author: x4nth055

README.md

@@ -38,6 +38,7 @@ This is a repository of all the tutorials of [The Python Code](https://www.thepy
     - [How to Make a Screen Recorder in Python](https://www.thepythoncode.com/article/make-screen-recorder-python). ([code](general/screen-recorder))
     - [How to Generate and Read QR Code in Python](https://www.thepythoncode.com/article/generate-read-qr-code-python). ([code](general/generating-reading-qrcode))
     - [How to Download Files in Python](https://www.thepythoncode.com/article/download-files-python). ([code](general/file-downloader))
+    - [How to Compress and Decompress Files in Python](https://www.thepythoncode.com/article/compress-decompress-files-tarfile-python). ([code](general/compressing-files))
 
 - ### [Web Scraping](https://www.thepythoncode.com/topic/web-scraping)
     - [How to Access Wikipedia in Python](https://www.thepythoncode.com/article/access-wikipedia-python). ([code](web-scraping/wikipedia-extractor))

general/compressing-files/README.md

@@ -0,0 +1,39 @@
+# [How to Compress and Decompress Files in Python](https://www.thepythoncode.com/article/compress-decompress-files-tarfile-python)
+To run this:
+- `pip3 install -r requirements.txt`
+- 
+    ```
+    python tar.py --help
+    ```
+    **Output:**
+    ```
+    usage: tar.py [-h] [-t TARFILE] [-p PATH] [-f FILES] method
+
+    TAR file compression/decompression using GZIP.
+
+    positional arguments:
+    method                What to do, either 'compress' or 'decompress'
+
+    optional arguments:
+    -h, --help            show this help message and exit
+    -t TARFILE, --tarfile TARFILE
+                            TAR file to compress/decompress, if it isn't specified
+                            for compression, the new TAR file will be named after
+                            the first file to compress.
+    -p PATH, --path PATH  The folder to compress into, this is only for
+                            decompression. Default is '.' (the current directory)
+    -f FILES, --files FILES
+                            File(s),Folder(s),Link(s) to compress/decompress
+                            separated by ','.
+    ```
+- If you want to compress one or more file(s)/folder(s):
+    ```
+    python tar.py compress -f test_folder,test.txt
+    ```
+    This will compress the folder `test_folder` and the file `test.txt` into a single TAR compressed file named: `test_folder.tar.gz`
+    If you want to name the TAR file yourself, consider using `-t` flag.
+- If you want to decompress a TAR file named `test_folder.tar.gz` into a new folder called `extracted` for instance:
+    ```
+    python tar.py decompress -t test_folder.tar.gz -p extracted
+    ```
+    A new folder `extracted` will appear that contains everything on `test_folder.tar.gz` decompressed.

general/compressing-files/requirements.txt

@@ -0,0 +1 @@
+tqdm

general/compressing-files/tar.py

@@ -0,0 +1,79 @@
+import tarfile
+from tqdm import tqdm # pip3 install tqdm
+
+
+def decompress(tar_file, path, members=None):
+    """
+    Extracts `tar_file` and puts the `members` to `path`.
+    If members is None, all members on `tar_file` will be extracted.
+    """
+    tar = tarfile.open(tar_file, mode="r:gz")
+    if members is None:
+        members = tar.getmembers()
+    # with progress bar
+    # set the progress bar
+    progress = tqdm(members)
+    for member in progress:
+        tar.extract(member, path=path)
+        # set the progress description of the progress bar
+        progress.set_description(f"Extracting {member.name}")
+    # or use this
+    # tar.extractall(members=members, path=path)
+    # close the file
+    tar.close()
+
+
+def compress(tar_file, members):
+    """
+    Adds files (`members`) to a tar_file and compress it
+    """
+    # open file for gzip compressed writing
+    tar = tarfile.open(tar_file, mode="w:gz")
+    # with progress bar
+    # set the progress bar
+    progress = tqdm(members)
+    for member in progress:
+        # add file/folder/link to the tar file (compress)
+        tar.add(member)
+        # set the progress description of the progress bar
+        progress.set_description(f"Compressing {member}")
+    # close the file
+    tar.close()
+
+
+# compress("compressed.tar.gz", ["test.txt", "test_folder"])
+# decompress("compressed.tar.gz", "extracted")
+
+if __name__ == "__main__":
+    import argparse
+    parser = argparse.ArgumentParser(description="TAR file compression/decompression using GZIP.")
+    parser.add_argument("method", help="What to do, either 'compress' or 'decompress'")
+    parser.add_argument("-t", "--tarfile", help="TAR file to compress/decompress, if it isn't specified for compression, the new TAR file will be named after the first file to compress.")
+    parser.add_argument("-p", "--path", help="The folder to compress into, this is only for decompression. Default is '.' (the current directory)", default="")
+    parser.add_argument("-f", "--files", help="File(s),Folder(s),Link(s) to compress/decompress separated by ','.")
+
+    args = parser.parse_args()
+    method = args.method
+    tar_file = args.tarfile
+    path = args.path
+    files = args.files
+
+    # split by ',' to convert into a list
+    files = files.split(",") if isinstance(files, str) else None
+
+    if method.lower() == "compress":
+        if not files:
+            print("Files to compress not provided, exiting...")
+            exit(1)
+        elif not tar_file:
+            # take the name of the first file
+            tar_file = f"{files[0]}.tar.gz"
+        compress(tar_file, files)
+    elif method.lower() == "decompress":
+        if not tar_file:
+            print("TAR file to decompress is not provided, nothing to do, exiting...")
+            exit(2)
+        decompress(tar_file, path, files)
+    else:
+        print("Method not known, please use 'compress/decompress'.")
+

general/compressing-files/test.txt

@@ -0,0 +1 @@
+Some text