django-attachments 1.0a2

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')),

4. Don’t forget to migrate your database:

   ./manage.py migrate

5. Grant the user some permissions:

   • For adding attachments grant the user (or group) the permission attachments.add_attachments.

   • For deleting attachments grant the user (or group) the permission attachments.delete_attachments. This allows the user to delete only attachments which are assigned to him (rather the attachments he uploaded self).

   • For deleting foreign attachments (attachments by other users) grant the user the permission attachments.delete_foreign_attachments.

   This only works for the templatetags, the admin still allows anybody to add or delete attachments.

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:

$ python ./runtests.py

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

$ tox -r

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,)

{% load attachments_tags %}

Quick Example:

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

{% 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 %}

In the console:

First, import the items you will need:

import os
from django.core.files import File
from attachments.models import Attachment
from myproject.models import Person

Next, retrieve the object you wish to attach to:

me = Person.objects.get(name='aaron')

Now open the attachment you want from your drive using the django File object:

mypicture = File(open('/home/aaron/mypicture.jpg', 'r'))

Finally, create the Attachment object and save it, and close the file handle:

a = Attachment()
a.creator = me
a.attachment_file = mypicture
a.save()
mypicture.close()

Changelog:

v1.0 alpha: (2016-03-19):

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

• 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')),

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!