Hopiu/django-downloadview
1
0
Fork 0
mirror of https://github.com/jazzband/django-downloadview.git synced 2026-03-16 22:40:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
Serve files with Django.
383 commits 4 branches 18 tags 910 KiB
Python 98.1%
Makefile 1.9%
Find a file
pre-commit-ci[bot] 840827da1d
[pre-commit.ci] pre-commit autoupdate 
updates:
- [github.com/pre-commit/pre-commit-hooks: v5.0.0 → v6.0.0](https://github.com/pre-commit/pre-commit-hooks/compare/v5.0.0...v6.0.0)
- [github.com/pycqa/doc8: v1.1.2 → v2.0.0](https://github.com/pycqa/doc8/compare/v1.1.2...v2.0.0)
- [github.com/adamchainz/django-upgrade: 1.22.2 → 1.29.0](https://github.com/adamchainz/django-upgrade/compare/1.22.2...1.29.0)
- [github.com/pre-commit/mirrors-eslint: v9.17.0 → v9.38.0](https://github.com/pre-commit/mirrors-eslint/compare/v9.17.0...v9.38.0)
- [github.com/astral-sh/ruff-pre-commit: v0.8.6 → v0.14.1](https://github.com/astral-sh/ruff-pre-commit/compare/v0.8.6...v0.14.1)
- [github.com/tox-dev/pyproject-fmt: v2.5.0 → v2.11.0](https://github.com/tox-dev/pyproject-fmt/compare/v2.5.0...v2.11.0)
- [github.com/abravalheri/validate-pyproject: v0.23 → v0.24.1](https://github.com/abravalheri/validate-pyproject/compare/v0.23...v0.24.1)
2025-10-20 17:24:32 +00:00
.github/workflows Upgrade support matrix to maintained versions of Django 2024-07-30 10:03:32 +00:00
demo Run pre-commit on all files 2024-08-05 10:53:19 +02:00
django_downloadview Run pre-commit on all files 2024-08-05 10:53:19 +02:00
docs Run pre-commit on all files 2024-08-05 10:53:19 +02:00
tests Run pre-commit on all files 2024-08-05 10:53:19 +02:00
.gitignore Drop support for end of life Django settings in demo project 2021-01-21 11:28:40 -05:00
.isort.cfg Migrate to GitHub Actions. (#165) 2020-12-23 11:12:35 +01:00
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate 2025-10-20 17:24:32 +00:00
.readthedocs.yaml Add readthedocs config 2024-08-05 10:50:24 +02:00
AUTHORS Update AUTHORS 2024-08-05 14:03:55 +02:00
CHANGELOG Post release 2.4.0 2024-08-05 14:51:35 +02:00
CODE_OF_CONDUCT.md Jazzband: Created local 'CODE_OF_CONDUCT.md' from remote 'CODE_OF_CONDUCT.md' 2022-02-17 11:46:17 +01:00
CONTRIBUTING.rst Run pre-commit on all files 2024-08-05 10:53:19 +02:00
INSTALL Drop Python 3.6 support 2022-08-04 09:22:28 -04:00
LICENSE Refs #74 - Switched to tox as test-environment manager. Added flake8 to the test suite. Dropped python 2.6 tests. Makefile no longer creates a virtualenv. 2014-02-10 01:27:14 +01:00
Makefile Migrate to GitHub Actions. (#165) 2020-12-23 11:12:35 +01:00
MANIFEST.in Migrate to GitHub Actions. (#165) 2020-12-23 11:12:35 +01:00
README.rst Run pre-commit on all files 2024-08-05 10:53:19 +02:00
setup.py Run pre-commit on all files 2024-08-05 10:53:19 +02:00
tox.ini Ensure tests are actually run 2024-08-01 06:24:00 +00:00

README.rst 

###################
django-downloadview
###################

.. image:: https://jazzband.co/static/img/badge.svg
    :target: https://jazzband.co/
    :alt: Jazzband

.. image:: https://img.shields.io/pypi/v/django-downloadview.svg
    :target: https://pypi.python.org/pypi/django-downloadview

.. image:: https://img.shields.io/pypi/pyversions/django-downloadview.svg
    :target: https://pypi.python.org/pypi/django-downloadview

.. image:: https://img.shields.io/pypi/djversions/django-downloadview.svg
    :target: https://pypi.python.org/pypi/django-downloadview

.. image:: https://img.shields.io/pypi/dm/django-downloadview.svg
    :target: https://pypi.python.org/pypi/django-downloadview

.. image:: https://github.com/jazzband/django-downloadview/workflows/Test/badge.svg
    :target: https://github.com/jazzband/django-downloadview/actions
    :alt: GitHub Actions

.. image:: https://codecov.io/gh/jazzband/django-downloadview/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/jazzband/django-downloadview
    :alt: Coverage

``django-downloadview`` makes it easy to serve files with `Django`_:

* you manage files with Django (permissions, filters, generation, ...);

* files are stored somewhere or generated somehow (local filesystem, remote
  storage, memory...);

* ``django-downloadview`` helps you stream the files with very little code;

* ``django-downloadview`` helps you improve performances with reverse proxies,
  via mechanisms such as Nginx's X-Accel or Apache's X-Sendfile.


*******
Example
*******

Let's serve a file stored in a file field of some model:

.. code:: python

   from django.conf.urls import url, url_patterns
   from django_downloadview import ObjectDownloadView
   from demoproject.download.models import Document  # A model with a FileField

   # ObjectDownloadView inherits from django.views.generic.BaseDetailView.
   download = ObjectDownloadView.as_view(model=Document, file_field='file')

   url_patterns = ('',
       url('^download/(?P<slug>[A-Za-z0-9_-]+)/$', download, name='download'),
   )


*********
Resources
*********

* Documentation: https://django-downloadview.readthedocs.io
* PyPI page: http://pypi.python.org/pypi/django-downloadview
* Code repository: https://github.com/jazzband/django-downloadview
* Bugtracker: https://github.com/jazzband/django-downloadview/issues
* Continuous integration: https://github.com/jazzband/django-downloadview/actions
* Roadmap: https://github.com/jazzband/django-downloadview/milestones

.. _`Django`: https://djangoproject.com