Skip to main content

A simple Django base view to tar and stream several files.

Project description

Django TarView

A base view to tar and stream several files.


pip install django-tarview

Usage and examples

To create a tar download view:

* Extend BaseTarView
* implement `get_files`
* That's it

The `get_files` method must return a list (or iterator) of file-like objects.

Example with a ContentFile:

from tarview.views import BaseTarView

class JustTextFilesView(BaseTarView):
Generate a tar with 10 files 'fileX.txt' with a simple text,
using Djangos ContentFile
def get_files(self):
for i in range(0,10):
file_like = ContentFile(b("This is file %d." % i), name="file%d.txt" % i)
yield file_like

Or pull them from a database like this:

from tarview.views import BaseTarView

from reviews import Review

class CommentsArchiveView(BaseTarView):
"""Download at once all comments for a review."""

def get_files(self):
document_key = self.kwargs.get('document_key')
reviews = Review.objects \
.filter(document__document_key=document_key) \

return [review.comments.file for review in reviews if]

View configuration

By default, the downloaded file is named `download.tar` you can set a custom name
by setting the `tarfile_name` parameter.


class TarView(BaseTarView):
tarfile_name = 'something.tar'


Django TarView uses [tox, the testing automation tool](,
to run tests.

To launch tests:

pip install tox


Crafted with love by luckydonald.
Modification of [Thibault Jouannic]('s work.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-tarview-1.0.0.tar.gz (4.3 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page