Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

django-attachments is generic Django application to attach Files (Attachments) to any model.

Project Description

django-attachments

django-attachments is a generic set of template tags to attach any kind of files to models.

Installation:

  1. Put attachments to your INSTALLED_APPS in your settings.py within your django project:

    INSTALLED_APPS = (
        ...
        'attachments',
    )
    
  2. Add the attachments urlpattern to your urls.py:

    url(r'^attachments/', include('attachments.urls', namespace='attachments')),
    
  3. Migrate your database:

    ./manage.py migrate
    
  1. Grant the user some permissions:
    • For adding attachments grant the user (or group) the permission attachments.add_attachment.
    • For deleting attachments grant the user (or group) the permission attachments.delete_attachment. This allows the user to delete their attachments only.
    • For deleting foreign attachments (attachments by other users) grant the user the permission attachments.delete_foreign_attachments.
  2. Set DELETE_ATTACHMENTS_FROM_DISK to True if you want to remove files from disk when Attachment objects are removed!
  3. Configure FILE_UPLOAD_MAX_SIZE (optional). This is the maximum size in bytes before raising form validation errors. If not set there is no restriction on file size.

Mind that you serve files!

django-attachments stores the files in your site_media directory and does not modify them. For example, if an user uploads a .html file your webserver will probably display it in HTML. It’s a good idea to serve such files as plain text. In a Apache2 configuration this would look like:

<Location /site_media/attachments>
    AddType text/plain .html .htm .shtml .php .php5 .php4 .pl .cgi
</Location>

Tests

Run the testsuite in your local environment using:

$ cd django-attachments/
$ pip intall -e .[tests]
$ ./runtests.py

Or use tox to test against various Django and Python versions:

$ tox -r

You can also invoke the test suite or other ‘manage.py’ commands by calling the django-admin tool with the test app settings:

$ cd django-attachments/
$ pip intall -e .[tests]
$ DJANGO_SETTINGS_MODULE=attachments.tests.testapp.settings django-admin
$ DJANGO_SETTINGS_MODULE=attachments.tests.testapp.settings django-admin test
$ DJANGO_SETTINGS_MODULE=attachments.tests.testapp.settings django-admin makemigrations --dry-run

Usage:

In contrib.admin:

django-attachments provides a inline object to add a list of attachments to any kind of model in your admin app.

Simply add AttachmentInlines to the admin options of your model. Example:

from django.contrib import admin
from attachments.admin import AttachmentInlines

class MyEntryOptions(admin.ModelAdmin):
    inlines = (AttachmentInlines,)

In your frontend templates:

First of all, load the attachments_tags in every template you want to use it:

{% load attachments_tags %}

django-attachments comes with some templatetags to add or delete attachments for your model objects in your frontend.

  1. get_attachments_for [object]: Fetches the attachments for the given model instance. You can optionally define a variable name in which the attachment list is stored in the template context (this is required in Django 1.8). If you do not define a variable name, the result is printed instead.

    {% get_attachments_for entry as “attachments_list” %}

  2. attachments_count [object]: Counts the attachments for the given model instance and returns an int:

    {% attachments_count entry %}
    
  3. attachment_form: Renders a upload form to add attachments for the given model instance. Example:

    {% attachment_form [object] %}
    

    It returns an empty string if the current user is not logged in.

  4. attachment_delete_link: Renders a link to the delete view for the given attachment. Example:

    {% for att in attachments_list %}
        {{ att }} {% attachment_delete_link att %}
    {% endfor %}
    

    This tag automatically checks for permission. It returns only a html link if the give n attachment’s creator is the current logged in user or the user has the delete_foreign_attachments permission.

Quick Example:

{% load attachments_tags %}
{% get_attachments_for entry as my_entry_attachments %}

<span>Object has {% attachments_count entry %} attachments</span>
{% if my_entry_attachments %}
<ul>
{% for attachment in my_entry_attachments %}
    <li>
        <a href="{{ attachment.attachment_file.url }}">{{ attachment.filename }}</a>
        {% attachment_delete_link attachment %}
    </li>
{% endfor %}
</ul>
{% endif %}

{% attachment_form entry %}

{% if messages %}
<ul class="messages">
{% for message in messages %}
    <li{% if message.tags %} class="{{ message.tags }}"{% endif %}>
        {{ message }}
    </li>
{% endfor %}
</ul>
{% endif %}

Changelog:

v1.3 (2018-01-09):

  • Added a missing database migration.
  • New templatetag attachments_count.
  • New setting DELETE_ATTACHMENTS_FROM_DISK to delete attachment files if the attachment model is deleted.
  • New setting FILE_UPLOAD_MAX_SIZE to deny file uploads exceeding this value.

v1.2 (2017-12-15):

  • Django 1.11 and 2.0 compatibility and tests.

v1.1 (2017-03-18):

  • Django 1.10 compatibility and tests.
  • Python 3.6 compatibility and tests.
  • Fixes problems where models have a foreign key named something other than “id”.

v1.0.1 (2016-06-12):

  • Added finnish translation.
  • Minor test suite improvements.

v1.0 (2016-03-19):

  • General code cleanup to keep compatibility with the latest Django (currently 1.8 upwards) as well as Python3. Introduced full testsuite.

  • Backwards incompatible: The attachment views now use a urlpattern namespace so you need to adjust the urlpattern:

    url(r'^attachments/', include('attachments.urls', namespace='attachments')),
    
  • Backwards incompatible: The quotes around the as variable name

    must be removed:

    {% get_attachments_for entry as "my_entry_attachments" %}
    
    becomes
    
    {% get_attachments_for entry as my_entry_attachments %}
    
  • Possibly backwards incompatible: The old version had bugs around

    permissions and were not enforcing it in all places. From now on the related permissions add_attachment and delete_attachment must been applied to all related users.

v0.3.1 (2009-07-29):

  • Added a note to the README that you should secure your static files.

v0.3 (2009-07-22):

  • This version adds more granular control about user permissons. You need to explicitly add permissions to users who should been able to upload, delete or delete foreign attachments.

    This might be backwards incompatible as you did not need to assign add/delete permissions before!

Release History

This version
History Node

1.3

History Node

1.2

History Node

1.1.1

History Node

1.1

History Node

1.0.1

History Node

1.0

History Node

1.0a2

History Node

1.0a1

History Node

1.0a0

History Node

0.3.1

History Node

0.3

History Node

0.2.6

History Node

0.2.5

History Node

0.2.4

History Node

0.2.3

History Node

0.2.2

History Node

0.2.1

History Node

0.2

Download Files

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

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
django-attachments-1.3.tar.gz
(13.0 kB) Copy SHA256 Hash SHA256
Source None Jan 9, 2018

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers DreamHost DreamHost Log Hosting