Python Extract tar.gz Files

Extracted file with the suffix tar.gz from the local path or remote path to output_path. Also, all the suffix with .gz files will be unzipped at the same time.

One more things, pyextract supports merge all extracted files into one new file. By default, the name of merged file is self.filename.log with python arg_parser, just change with the --merge_file or -m option as you wish.

For example, a compressed package with the suffix tar.gz(named 123456_abc.tar.gz) that stores the other compressed packages and files, as follows:

.
└── log
    └── file
        ├── 1.gz
        ├── 2.gz
        ├── 3.gz
        ├── 4.gz
        └── tmp.log

Additionally, the files in the .tar.gz package are compressed packages with .gz as the suffix, and include a specific file, used to help us find the path where the .gz file located. We assume it is called tmp.log, which is free and you can modify it according to you want.

Getting Started

Clone the repo to local

git clone https://github.com/Junbo-Zheng/pyextract

set alias to local bash

• zsh

echo "alias pyextract=\'$(pwd)/pyextract.py\'" >> ~/.zshrc
source ~/.zshrc

• bash

echo "alias pyextract=\'$(pwd)/pyextract.py\'" >> ~/.bashrc
source ~/.bashrc

Usage

➜  /Users/junbozheng/project/pyextract git:(master) ./pyextract.py --help
Parameter Number : 2
Parameter Lists  : ['./pyextract.py', '--help']
Shell Name       : ./pyextract.py
usage: pyextract.py [-h] [-o OUTPUT_PATH [OUTPUT_PATH ...]] [-P [PASSWORD]] -s SOURCE_PATH [SOURCE_PATH ...] [-m MERGE_FILE [MERGE_FILE ...]] -f FILENAME [-p]
                    [-F FILTER_PATTERN]

Extract a file with the suffix `.tar.gz` from the source path or remote path and extract to output_path.

optional arguments:
  -h, --help            show this help message and exit
  -o OUTPUT_PATH [OUTPUT_PATH ...], --output_path OUTPUT_PATH [OUTPUT_PATH ...]
                        extract packet output path
  -P [PASSWORD], --password [PASSWORD]
                        extract packet and chmod with user password
  -s SOURCE_PATH [SOURCE_PATH ...], --source_path SOURCE_PATH [SOURCE_PATH ...]
                        extract packet from source path
  -m MERGE_FILE [MERGE_FILE ...], --merge_file MERGE_FILE [MERGE_FILE ...]
                        extract packet and merge to a new file
  -f FILENAME, --filename FILENAME
                        extract packet filename, the default file suffix is .tar.gz, such as: log.tar.gz
  -p, --purge_source_file
                        purge source file if is true
  -F FILTER_PATTERN, --filter_pattern FILTER_PATTERN
                        filter the files to be merged

There are two ways that supported to extract files:

+------------------------+---------------------+
+        Android         +   -----------+      |
+         Phone          +              |      |
+  /sdcard/Android/data  +              |      |
+------------------------+             \|/     |
                                               |
                                              \|/    pyextract.py
                                               +-------------------> local output path
                                              /|\                  (./file path by default)
+----------------------+               /|\     |
+       Ubuntu         +                |      |
+        20.04         +                |      |
+  /home/mi/downloads  +     -----------+      |
+----------------------+-----------------------+

• Ubuntu 20.04 LTS local path with the filename and the suffix is .tar.gz. In this case, you can type

  ./pyextract.py --password 1234 --filename 123456_abc --source_path /Users/junbozheng/test

  When we have already downloaded the file we want to extract in advance, we can quickly extract it through pyextract.

• Android phone path with the filename and the suffix is .tar.gz. In this case, you can type

  ./pyextract.py --password 1234 --filename 123456_abc --source_path phone

  pyextract will use adb pull command to pull files from the remote_path to local and extract.

  When some files are stored on phone, we can pull them and extract them quickly with pyextract. In advance, our computer already connected to our phone through USB or the other ways.

License

pyextract is licensed under the Apache license, check the LICENSE file.