Metadata-Version: 2.1
Name: zipfile-zstd
Version: 0.0.1
Summary: Monkey patch the standard zipfile module to enable Zstandard support
Home-page: https://github.com/taisei-project/python-zipfile-zstd
Author: Andrei Alexeyev
Author-email: akari@taisei-project.org
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/taisei-project/python-zipfile-zstd/issues
Description: # zipfile-zstd
        [![PyPI](https://img.shields.io/pypi/v/zipfile-zstd)](https://pypi.org/project/zipfile-zstd/)
        
        Monkey patch the standard `zipfile` module to enable Zstandard support.
        
        Based on [`zipfile-deflate64`](https://github.com/brianhelba/zipfile-deflate64), which provides similar functionality but for the `deflate64` algorithm. Unlike `zipfile-deflate64`, this package supports both compression and decompression.
        
        Requires [`python-zstandard`](https://github.com/indygreg/python-zstandard) for libzstd bindings.
        
        ## Installation
        ```bash
        pip install zipfile-zstd
        ```
        
        ## Usage
        Anywhere in a Python codebase:
        ```python
        import zipfile_zstd  # This has the side effect of patching the zipfile module to support Zstandard
        ```
        
        Alternatively, `zipfile_zstd` re-exports the `zipfile` API, as a convenience:
        ```python
        import zipfile_zstd as zipfile
        
        zipfile.ZipFile(...)
        ```
        
        Compression example:
        ```python
        import zipfile_zstd as zipfile
        
        zf = zipfile.ZipFile('/tmp/test.zip', 'w', zipfile.ZIP_ZSTANDARD, compresslevel=19)
        zf.write('large_file.img')
        ```
        
        Dictionaries and advanced compression parameters are not supported, sorry.
        
        
Keywords: zip zipfile zstd zstandard
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
