Metadata-Version: 2.1
Name: zipfile-xz
Version: 0.0.3.1
Summary: Monkey patch the standard zipfile module to enable XZ support
Home-page: https://github.com/cielavenir/python-zipfile-ppmd
Author: cielavenir
Author-email: cielartisan@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/cielavenir/python-zipfile-ppmd/issues
Keywords: zip zipfile xz
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: System :: Archiving
Classifier: Topic :: System :: Archiving :: Compression
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# zipfile-xz
[![PyPI](https://img.shields.io/pypi/v/zipfile-xz)](https://pypi.org/project/zipfile-xz/)

Monkey patch the standard `zipfile` module to enable XZ support.

Based on [`zipfile-deflate64`](https://github.com/brianhelba/zipfile-deflate64) and [`zipfile-zstandard`](https://github.com/taisei-project/python-zipfile-zstd), which provides similar functionality but for the `deflate64` algorithm. Unlike `zipfile-deflate64`, this package supports both compression and decompression.

Note: if you need Python2, use [zipfile39](https://github.com/cielavenir/zipfile39) instead (it is also compatible with Python3).

Note: XZ is based on LZMA2, so the compression ratio will be similar to ZIP_LZMA.

## Installation
```bash
pip install zipfile-xz
```

## Usage
Anywhere in a Python codebase:
```python
import zipfile_xz  # This has the side effect of patching the zipfile module to support XZ
```

Alternatively, `zipfile_ppmd` re-exports the `zipfile` API, as a convenience:
```python
import zipfile_xz as zipfile

zipfile.ZipFile(...)
```

Compression example:
```python
import zipfile_xz as zipfile

zf = zipfile.ZipFile('/tmp/test.zip', 'w', zipfile.ZIP_XZ, compresslevel=6)
zf.write('large_file.img')
```



