django-downloadview/django_downloadview/shortcuts.py

"""Port of django-sendfile in django-downloadview."""

from django_downloadview.views.path import PathDownloadView


def sendfile(
    request,
    filename,
    attachment=False,
    attachment_filename=None,
    mimetype=None,
    encoding=None,
):
    """Port of django-sendfile's API in django-downloadview.

    Instantiates a :class:`~django_downloadview.views.path.PathDownloadView` to
    stream the file by ``filename``.

    """
    view = PathDownloadView.as_view(
        path=filename,
        attachment=attachment,
        basename=attachment_filename,
        mimetype=mimetype,
        encoding=encoding,
    )
    return view(request)