Metadata-Version: 2.1
Name: pyziper
Version: 0.3
Summary: pyziper a simple cli tools to help you to handle archive file ,like zipping and unzipping 
Home-page: https://github.com/AlphaBeta1906/pyziper
Author: fariz
Author-email: farizi1906@gmail.com
License: UNKNOWN
Download-URL: https://github.com/AlphaBeta1906/pyziper/archive/refs/tags/v0.3.tar.gz
Keywords: tools,cli,zip,7z,tar,archive
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Description-Content-Type: text/markdown

# pyziper

pyziper a simple cli tools to help you to handle archive file ,like zipping and unzipping 


## installing 
install from pip: 
```bash
pip install patool # this is required and install it globally
pip install pyziper
```
install from source : 

```bash
git clone https://github.com/AlphaBeta1906/pyziper.git
cd pyziper

pip install patool
pip install -e . # install it globally so you can use it everywhere in  your machine
```

## usage 

### zipping/archiving

simple usage to zip a folder:
```bash
pyziper zip folder_name zip_name
```

complete command to zip file(s)/folder(s):
```bash
pyziper zip folder_name zip_name --type zip|7z|tar --multi  --output output_dir
```

by default your folder is archived using standard zip method(`.zip`) and output zip file will appear in current dir.  
there are 2 other types of archive method that are supported by pyziper, that is tar.gz and 7z, you can access them using the `-T`/`--type` option,example :  
```bash
# 7z
pyziper zip folder_name zip_name -T 7z

#tar.gz
pyziper zip folder_name zip_name -T tar

#zip/default

pyziper zip folder_name zip_name -T zip

# or simply
pyziper zip folder_name zip_name
```
*Note : please dont use ../ to zip a file,pyziper only zip files/folder in current diectory or subdirectory of current directory,not files/folders in previouse directory otherwise archive will error when exctracting*

you also can spicify output dir by using `-O`/`--output` options,example: 
```bash 
pyziper zip folder_name zip_name -T  tar -O 
```

in version 0.2,`--multi`/`-m` was added,and used to add multiple folders or/and files separated by coma into archive,example:
```bash
pyziper zip folder1,folder2,file1,file2.... zip_file -T 7z|tar --multi --output output/dir/
```
*Note : default zip(`.zip`) currently doesnt have support to archive multiple folders or files. it only worked for 7z and tar.gz archive*


### unziping/extracting
simple usage of unzipping
```bash
pyziper unzip zip_name.zip|7z|tar.gz --output output_dir
```

#### option in pyziper(current)
| option      | function |
| ----------- | ----------- |
| `--type`/`-T`   | defining archive type,default is `.zip`  |
| `--multi`/`-M`  | if it enabled, it will allow you to archive multiple files and/or folders only for `7z` and `tar` type |
| `--output`/`-O` | defining output directory for your archived file,default is your current working directory |


new feature will be added soon

