Metadata-Version: 2.1
Name: pigz-python
Version: 1.0.1
Summary: A pure Python implementation of the pigz utility.
Home-page: https://github.com/nix7drummer88/pigz-python
Author: Ben Guise
Author-email: bguise135@gmail.com
Maintainer: Ben Guise
Maintainer-email: bguise135@gmail.com
License: MIT
Keywords: zip gzip compression
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown

# pigz-python
The goal of this project is to create a pure Python implementation of the pigz project for parallelizing gzipping.


# Usage examples

pigz-python can be utilized by creating a `PigzFile` object and calling the `process_compression_target()` method.

```python
from pigz_python import PigzFile

pigz_file = PigzFile('foo.txt')
pigz_file.process_compression_target()
```

Alternatively, the pigz_python module also provides a convenient helper method to do all of this work for you.

```python
import pigz_python

pigz_python.compress_file('foo.txt')
```


