django-attachments is a generic set of template tags to attach any kind of files to models.
Put
attachmentsto yourINSTALLED_APPSin yoursettings.pywithin your django project:INSTALLED_APPS = ( ... 'attachments', )
Add the attachments urlpattern to your
urls.py:url(r'^attachments/', include('attachments.urls', namespace='attachments')),
Migrate your database:
./manage.py migrate
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.
- For adding attachments grant the user (or group) the permission
Set
DELETE_ATTACHMENTS_FROM_DISKtoTrueif you want to remove files from disk when Attachment objects are removed!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.
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>django-attachments provides the delete_stale_attachments management command.
It will remove all attachments for which the related objects don't exist anymore!
Sys-admins could then:
./manage.py delete_stale_attachmentsYou may also want to execute this via cron.
Installing a local devel environment with pipenv.
It creates a virtualenv for you with the right ENV variables loaded from .env.
# pip install pipenv $ pipenv install Loading .env environment variables... Installing dependencies from Pipfile.lock (a053bc)... To activate this project's virtualenv, run pipenv shell. Alternatively, run a command inside the virtualenv with pipenv run.
Run the testsuite in your local environment using pipenv:
$ cd django-attachments/
$ pipenv install --dev
$ pipenv run pytest attachments/Or use tox to test against various Django and Python versions:
$ tox -rYou 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/
$ pipenv install --dev
$ pipenv run test
$ pipenv run django-admin.py runserver
$ pipenv run django-admin makemigrations --dry-run$ git tag $ change version in setup.cfg $ pip install -U setuptools $ python setup.py sdist && python setup.py bdist_wheel --universal $ twine upload --sign dist/*
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,)
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.
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 %}
attachments_count [object]: Counts the attachments for the given model instance and returns an int:{% attachments_count entry %}
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.
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_attachmentspermission.
{% 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 %}DELETE_ATTACHMENTS_FROM_DISKwill delete attachment files when the attachment model is deleted. Default False!FILE_UPLOAD_MAX_SIZEin bytes. Deny file uploads exceeding this value. Undefined by default.AppConfig.attachment_validators- a list of custom form validator functions which will be executed against uploaded files. If any of them raisesValidationErrorthe upload will be denied. Empty by default. Seeattachments/tests/testapp/apps.pyfor an example.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent