Metadata-Version: 2.1
Name: bkpk
Version: 0.2.23
Summary: A simple tool for converting a folder to a file and the other way around.
Author: nsde
Author-email: mail@onlix.me
License: MIT
Project-URL: Documentation, https://github.com/nsde/bkpk#readme
Project-URL: Changes, https://github.com/nsde/bkpk/commits/master
Project-URL: Source Code, https://github.com/nsde/bkpk
Project-URL: Issue Tracker, https://github.com/nsde/bkpk/issues
Keywords: backpack,bkpk,zip,unzip,package,backpkg,bkpack,backpk,bkpkg,compress,file
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Desktop Environment :: File Managers
Classifier: Topic :: Multimedia
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# 🎒 Backpack (`bkpk`)
A super simple and lightweight zip alternative. No encryption, compression or anything, just a simple file packer and unpacker using the Python builtin `pickle`. Supports files of pretty much any type.

## Installation
### Pip (recommended)
```
pip install bkpk
```
or
```
python -m pip install bkpk
```

### Manual (advanced users only)
```
git clone https://github.com/nsde/bkpk.git
python bkpk 
```

Please note that this won't create a shell command, so you need to write `python /home/user/Downloads/bkpk/bkpk` (replace the example with your according values!) instead of just `bkpk`. Linux users add rights to the `bkpk.sh` using `sudo chmod +x bkpk.sh` and copy the file using `sudo cp bkpk.sh /usr/bin/bkpk`

## Commands
### Zipping a folder / Creating a backpack
```
bkpk example/
```

This will create a `example.bkpk` in your current directory.

### Unzipping a backpack
```
bkpk example.bkpk
```

This will create all directories and files which are stored in the backpack.

## Python API
```py
import bkpk

bkpk.save('example/')
bkpk.load('example.bkpk')

```
