python-zipstream

zipstream.py is a zip archive generator based on python 3.3's zipfile.py. It was created to generate a zip file generator for streaming (ie web apps). This is beneficial for when you want to provide a downloadable archive of a large collection of regular files, which would be infeasible to generate the archive prior to downloading.

The archive is generated as an iterator of strings, which, when joined, form the zip archive. For example, the following code snippet would write a zip archive containing files from 'path' to a normal file:

zf=open('zipfile.zip', 'wb')
fordatainZipStream(path):
zf.write(data)
zf.close()

Since recent versions of web.py support returning iterators of strings to be sent to the browser, to download a dynamically generated archive, you could use something like this snippet:

defGET(self):
path='/path/to/dir/of/files'zip_filename='files.zip'web.header('Content-type' , 'application/zip')
web.header('Content-Disposition', 'attachment; filename="%s"'% (
zip_filename,))
returnZipStream(path)

If the zlib module is available, ZipStream can generate compressed zip archives.

Requirements

• Python 2.6, 2.7, 3.2, 3.3, pypy

Examples

flask

fromflaskimportResponse@app.route('/package.zip', methods=['GET'], endpoint='zipball')defzipball():
defgenerator():
z=ZipStream(mode='w', compression=ZIP_DEFLATED)
z.write('/path/to/file')
forchunkinz:
yieldchunkresponse=Response(generator(), mimetype='application/zip')
response.headers['Content-Disposition'] ='attachment; filename={}'.format('files.zip')
returnresponse# or@app.route('/package.zip', methods=['GET'], endpoint='zipball')defzipball():
z=ZipStream(mode='w', compression=ZIP_DEFLATED)
z.write('/path/to/file')
response=Response(z, mimetype='application/zip')
response.headers['Content-Disposition'] ='attachment; filename={}'.format('files.zip')
returnresponse

django 1.5+

fromdjango.httpimportStreamingHttpResponsedefzipball(request):
z=ZipStream(mode='w', compression=ZIP_DEFLATED)
z.write('/path/to/file')
response=StreamingHttpResponse(z, mimetype='application/zip')
response['Content-Disposition'] ='attachment; filename={}'.format('files.zip')
returnresponse

webpy

defGET(self):
path='/path/to/dir/of/files'zip_filename='files.zip'web.header('Content-type' , 'application/zip')
web.header('Content-Disposition', 'attachment; filename="%s"'% (
zip_filename,))
returnZipStream(path)