Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sandes/zipfly
Python Zip Stream
https://github.com/sandes/zipfly
buzon compression memory-inflation python streaming zipfile zipfly
Last synced: 10 days ago
JSON representation
Python Zip Stream
- Host: GitHub
- URL: https://github.com/sandes/zipfly
- Owner: sandes
- License: mit
- Created: 2020-03-24T01:36:38.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-04T14:54:39.000Z (9 months ago)
- Last Synced: 2024-04-12T10:15:52.349Z (3 months ago)
- Topics: buzon, compression, memory-inflation, python, streaming, zipfile, zipfly
- Language: Python
- Homepage:
- Size: 633 KB
- Stars: 517
- Watchers: 11
- Forks: 26
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-stars - sandes/zipfly - Python Zip Stream (Python)
- my-stars - sandes/zipfly - Python Zip Stream (Python)
- awesome-stars - sandes/zipfly - `★521` Python Zip Stream (Python)
README
[](https://app.circleci.com/pipelines/github/sandes/zipfly)
[](https://pepy.tech/project/zipfly)
# ZipFly
ZipFly is a zip archive generator based on zipfile.py.
It was created to generate very large ZIP archives for immediate sending out to clients, or for writing large ZIP archives without memory inflation.
# Requirements
Python 3.6+ Added support for writing to unseekable streams.
# Install
pip3 install zipfly
# Basic usage, compress on-the-fly during writes
Using this library will save you from having to write the Zip to disk. Some data will be buffered by the zipfile deflater, but memory inflation is going to be very constrained. Data will be written to destination by default at regular 32KB intervals.
`ZipFly` defaults attributes:
- paths: [ ]
- mode: (write) w
- chunksize: (bytes) 32768
- compression: Stored
- allowZip64: True
- compresslevel: None
- storesize: (bytes) 0
- encode: utf-8
`paths` list of dictionaries:
| |.
|---------------- |-------------------------------
|**fs** |Should be the path to a file on the filesystem
|**n** *(Optional)* |Is the name which it will have within the archive
(by default, this will be the same as **fs**)
```python
import zipfly
paths = [
{
'fs': '/path/to/large/file'
},
]
zfly = zipfly.ZipFly(paths = paths)
generator = zfly.generator()
print (generator)
#
with open("large.zip", "wb") as f:
for i in generator:
f.write(i)
```
# Examples
> Streaming multiple files in a zip with Django or Flask
Send forth large files to clients with the most popular frameworks
> Create paths
Easy way to create the array `paths` from a parent folder.
> Predict the size of the zip file before creating it
Use the `BufferPredictionSize` to compute the correct size of the resulting archive before creating it.
> Streaming a large file
Efficient way to read a single very large binary file in python
> Set a comment
Your own comment in the zip file