Skip to main content

Asynchronous file upload for Django

Project description

paper-uploads

Асинхронная загрузка файлов для административного интерфейса Django.

PyPI Build Status Software license

Requirements

Features

  • Каждый файл представлен своей моделью. Это позволяет хранить вместе с файлом дополнительные данные. Например, alt для изображений.
  • Загрузка файлов происходит асинхронно и начинается сразу при выборе файла в интерфейсе администратора.
  • Поля модели, предоставляемые библиотекой paper-uploads, являются производными от OneToOneField и не используют <input type="file">. Благодаря этому, при ошибках валидации формы прикрепленные файлы не сбрасываются.
  • Загруженные картинки можно нарезать на множество вариаций. Каждая вариация гибко настраивается. Можно указать размеры, качество сжатия, формат, добавить дополнительные pilkit-процессоры, распознавание лиц и прочее.
    См. variations.
  • Совместим с django-storages.
  • Опциональная интеграция с django-rq для отложенной нарезки картинок на вариации.
  • Возможность создавать коллекции файлов. В частности, галерей изображений с возможностью сортировки элементов.
  • Внутренний подмодуль paper_uploads.cloudinary предоставляет поля и классы, реализующие хранение файлов в облаке Cloudinary.

Table of Contents

Installation

Install paper-uploads:

pip install paper-uploads[full]

Add paper_uploads to INSTALLED_APPS in settings.py:

INSTALLED_APPS = [
    # ...
    "paper_uploads",
    # ...
]

Configure paper-uploads in django's settings.py:

PAPER_UPLOADS = {
    "VARIATION_DEFAULTS": {
        "jpeg": dict(
            quality=80,
            progressive=True,
        ),
        "webp": dict(
            quality=75,
        )
    }
}

# Add JS translations
PAPER_LOCALE_PACKAGES = [
   "paper_admin",
   "paper_uploads",
   "django.contrib.admin",
]

Описание

В состав библиотеки входит два поля — FileField и ImageField — и модель Collection, предназначенная для группировки загруженных файлов с целью создания, к примеру, фотогалерей.

С примерами использования библиотеки вы можете ознакомиться здесь.

FileField и ImageField

from django.db import models
from django.utils.translation import gettext_lazy as _
from paper_uploads.models import FileField, ImageField


class Page(models.Model):
    file = FileField(
        _("file"),
        blank=True
    )
    image = ImageField(
        _("image"),
        blank=True
    )

image

Эти поля используются для тех же целей, что и одноимённые стандартные поля Django — для загрузки файлов и изображений — но имеют ряд существенных отличий.

Главное отличие заключается в том, что поля FileField и ImageField являются производными от стандартного OneToOneField. Соответственно, загруженные файлы представлены экземплярами полноценных моделей.

Поля моделей загруженных файлов

Файлы, загруженные с помощью полей FileField и ImageField, хранятся в экземплярах моделей UploadedFile и UploadedImage соответственно.

В следующих таблицах перечислены общие поля и свойства обеих моделей:

Поле Описание
resource_name Имя файла без пути, суффикса и расширения.
Пример: report2020.
extension Расширение файла в нижнем регистре без точки.
Пример: pdf.
size Размер файла в байтах.
checksum Контрольная сумма содержимого файла.
Используется для отслеживания изменений файла.
uploaded_at Дата и время загрузки файла.
created_at Дата и время создания экземпляра модели.
modified_at Дата и время изменения экземпляра модели.
Свойство Описание
name Полное имя файла.
Пример: files/report2020_19sc2Kj.pdf.
url URL-адрес файла.
Пример: /media/files/report2020_19sc2Kj.pdf.
path Абсолютный путь к файлу.
Пример: /home/www/django/media/files/report2020_19sc2Kj.pdf.

Ниже перечислены поля и свойства, специфичные для каждой модели.

Специфичные поля UploadedFile:

Поле Описание
display_name Удобочитаемое название файла для вывода на сайте.
Заполняется в диалоговом окне редактирования файла.
Пример: Annual report 2020.

Специфичные поля UploadedImage:

Поле Описание
title Название изображения, которое можно вставить в атрибут title тэга <img>.
description Описание изображения, которое можно вставить в атрибут alt тэга <img>.
width Ширина загруженного изображения.
height Высота загруженного изображения.

Большинство полей заполняются автоматически при загрузке файла и предназначены только для чтения. Но такие поля, как display_name или title, заполняются пользователем в диалоговом окне редактирования файла:

image image

Storage

По умолчанию все поля paper-uploads используют единый экземпляр хранилища, определяемый настройками STORAGE и STORAGE_OPTIONS:

# settings.py

PAPER_UPLOADS = {
    "STORAGE": "django.core.files.storage.FileSystemStorage",
    "STORAGE_OPTIONS": {},
    # ...
}

Вы можете указать экземпляр хранилища для конкретного поля:

from django.db import models
from django.core.files.storage import FileSystemStorage
from django.utils.translation import gettext_lazy as _
from paper_uploads.models import FileField


class Page(models.Model):
    report = FileField(
        _("report"), 
        blank=True,
        storage=FileSystemStorage(location="uploads/"),
        upload_to="reports/%Y/%m"
    )

Каталог загрузки файла

Все поля используют единые значения, указанные в настройках FILES_UPLOAD_TO и IMAGES_UPLOAD_TO:

# settings.py

PAPER_UPLOADS = {
    # ...
    "FILES_UPLOAD_TO": "files/%Y/%m/%d",
    "IMAGES_UPLOAD_TO": "images/%Y/%m/%d",
    # ...
}

Для конкретного поля каталог сохранения можно указать в параметре поля upload_to. Параметр поддерживает форматирование strftime(), которое будет заменено на дату/время загруженного файла (и загружаемые файлы не заполнят один каталог).

from django.db import models
from django.utils.translation import gettext_lazy as _
from paper_uploads.models import FileField


class Page(models.Model):
    report = FileField(
        _("report"), 
        blank=True,
        upload_to="pdf/reports/%Y"
    )

Обратите внимание, что в параметр upload_to нельзя передать вызываемый объект.

Если вам требуется динамическое определение каталога или имени загруженного файла, создайте proxy-модель и переопрелите метод generate_filename():

import os
import datetime
from django.db import models
from django.utils.translation import gettext_lazy as _
from paper_uploads.models import FileField, UploadedFile


class UploadedFileProxy(UploadedFile):
    class Meta:
        proxy = True

    def generate_filename(self, filename: str) -> str:
        _, ext = os.path.splitext(filename)
        filename = "proxy-files/file-%Y-%m-%d_%H%M%S{}".format(ext)
        filename = datetime.datetime.now().strftime(filename)

        storage = self.get_file_storage()
        return storage.generate_filename(filename)


class Page(models.Model):
    file = FileField(
        _("file"),
        to=UploadedFileProxy,
        blank=True,
    )

Валидаторы

На загружаемые файлы можно наложить ограничения с помощью валидаторов.

Модуль paper-uploads.validators предоставляет следующие классы для валидации файлов:

  • MaxSizeValidator - задает максимально допустимый размер файла.
    Максимальный размер можно указать как в виде числа (в байтах), так и в виде строки.
    Например: 4 * 10 ** 6, 4mb, 4MB, 4M.
  • ExtensionValidator - задает допустимые расширения файлов.
  • MimeTypeValidator - задает допустимые MIME-типы файлов.
  • ImageMinSizeValidator - устанавливает минимальный размер загружаемых изображений.
  • ImageMaxSizeValidator - устанавливает максимальный размер загружаемых изображений.

Пример:

from django.db import models
from django.utils.translation import gettext_lazy as _
from paper_uploads.models import FileField
from paper_uploads.validators import ExtensionValidator, MaxSizeValidator


class Page(models.Model):
    report = FileField(
        _("file"), 
        blank=True,
        validators=[
            ExtensionValidator([".pdf", ".doc", ".docx"]),
            MaxSizeValidator("10MB")
        ]
    )

Ограничения, наложенные этими валидаторами, отображаются в виджете: image

Программная загрузка файлов

from paper_uploads.models import *

report = UploadedFile()
report.set_owner_field(Page, "report")
report.attach("/tmp/file.doc")
report.save()

page = Page.objects.create(
    report=report
)

В метод set_owner_field() передаётся модель и имя поля модели, в которое будет сохранен экземпляр модели файла. Эти данные необходимы для выявления файлов, которые нигде не используются.

Метод attach() производит непосредственное сохранение файла и заполняет экземпляр дополнительными данными. В метод можно передать как путь к локальному файлу, так и файловый объект.

Вариации

ImageField позволяет создавать вариации для загруженного изображения. Вариация - это изображение, полученное из исходного по заранее объявленным правилам.

Для создания вариаций используется библиотека variations.

from django.db import models
from django.utils.translation import gettext_lazy as _
from paper_uploads.models import *


class Page(models.Model):
    image = ImageField(
        _("image"), 
        blank=True,
        variations=dict(
            desktop=dict(
                size=(800, 0),
                clip=False,
            ),
            mobile=dict(
                size=(600, 0),
                clip=False,
            ),
        )
    )

К файлам вариаций можно обратиться через модель UploadedImage используя их имена:

print(page.image.desktop.url)
# /media/images/2022/02/21/sample.desktop.jpg

Создание файлов вариаций происходит в момент загрузки изображения на сервер. Поэтому изменение настроек вариаций не окажет никакого эффекта на уже загруженные изображения.

Для того, чтобы создать файлы для новых вариаций (либо перезаписать существующие файлы вариаций) можно поступить одним из ниже описанных способов.

  1. Вызвать метод recut():

    page.image.recut()
    

    При вызове этого метода все файлы вариаций для текущего экземпляра создаются заново.

    Можно явно указать имена вариаций, которые необходимо перезаписать:

    page.image_group.recut(["desktop", "mobile"]) 
    
  2. Выполнить management-команду recreate_variations:

    python3 manage.py recreate_variations app.page \ 
            --field image
            --variations desktop mobile
    

    Эта команда сгенерирует вариации для всех экземпляров указанной модели.

Версии вариаций

Допустим, у нас есть изображение, которое нужно отобразить в трех вариантах: desktop, tablet и mobile. Если мы хотим поддерживать дисплеи Retina, нам нужно добавить ещё три вариации для размера 2x. Если мы также хотим использовать формат WebP (сохранив исходный формат для обратной совместимости), то общее количество вариаций достигает 12.

Поскольку Retina-вариации отличаются от обычных только увеличенным на постоянный коэффициент размером, а WebP-вариации — добавлением параметра format = "webp", мы можем создавать эти вариации автоматически. Это и есть версии вариации.

Перечень версий, которые нужно сгенерировать, указываются в параметре вариации versions. Поддерживаются следующие значения: webp, 2x, 3x, 4x.

from django.db import models
from django.utils.translation import gettext_lazy as _
from paper_uploads.models import *


class Page(models.Model):
    image = ImageField(
        _("image"), 
        blank=True,
        variations=dict(
            desktop=dict(
                # ...
                versions={"webp", "2x", "3x"}
            )
        )
    )

Приведенный выше код создаст следующие вариации:

  • desktop - оригинальная вариация
  • desktop_webp - WebP-версия оригинальной вариации
  • desktop_2x - Retina 2x
  • desktop_webp_2x - WebP-версия Retina 2x
  • desktop_3x - Retina 3x
  • desktop_webp_3x - WebP-версия Retina 3x

NOTE: Retina-суффикс всегда следует после суффикса webp, если он есть.

Если необходимо переопределить какие-то параметры дополнительной вариации, то придётся объявлять вариацию явно:

from django.db import models
from django.utils.translation import gettext_lazy as _
from paper_uploads.models import *


class Page(models.Model):
    image = ImageField(
        _('image'), 
        blank=True,
        variations=dict(
            desktop=dict(
                size=(800, 600),
                versions={'webp', '2x', '3x'}
            ),
            desktop_2x=dict(
                size=(1600, 1200),
                jpeg=dict(
                    quality=72
                )
            )
        )
    )

Redis Queue

При загрузке большого количества изображений процесс создания вариаций может занимать значительное время. Эту работу можно вынести в отдельный процесс с помощью django-rq:

pip install django-rq
# settings.py
PAPER_UPLOADS = {
    "RQ_ENABLED": True,
    "RQ_QUEUE_NAME": "default",
    # ...
}

Теперь при загрузке изображений, в очередь под именем default будет добавляться задача, которая создаст все необходимые вариации.

SVGFileField

Поле SVGFileField предназначено для загрузки SVG-файлов. Оно идентично FileField, но связанная с ним модель UploadedSVGFile включает несколько дополнительных полей:

Поле Описание
width Ширина изображения в формате Decimal. Может быть вещественным числом.
height Высота изображения в формате Decimal. Может быть вещественным числом.
title Название изображения, которое можно вставить в атрибут title тэга <img>.
description Описание изображения, которое можно вставить в атрибут alt тэга <img>.
from django.db import models
from django.utils.translation import gettext_lazy as _
from paper_uploads.models import SVGFileField


class Page(models.Model):
    svg = SVGFileField(
        _("svg"),
        blank=True
    )

Коллекции

Коллекция — это модель, группирующая экземпляры других моделей (элементов коллекции). В частности, с помощью коллекции можно создать фотогалерею или список файлов.

Для создания коллекции необходимо объявить класс, унаследованный от Collection и указать модели элементов, которые могут входить в коллекцию с помощью псевдо-поля CollectionItem:

from django.db import models
from paper_uploads.models import *


# Collection model
class PageFiles(Collection):
    svg = CollectionItem(SVGItem)
    image = CollectionItem(ImageItem)
    file = CollectionItem(FileItem)


class Page(models.Model):
    files = CollectionField(PageFiles)

Класс Collection обладает особенным свойством: любой дочерний класс, унаследованный от Collection, является proxy-моделью для Collection.

В большинстве случаев коллекции отличаются друг от друга только набором элементов, которые могут входить в коллекцию. Использование proxy-моделей предотвращает создание множества одинаковых таблиц в БД.

Если же для коллекции необходима отдельная таблица (например, если вы решили добавить в неё новое поле), то необходимо явно установить свойство Meta.proxy в значение False:

from django.db import models
from paper_uploads.models import *


class CustomCollection(Collection):
    name = models.CharField("name", max_length=128, blank=True)

    file = CollectionItem(FileItem)

    class Meta:
        proxy = False

Элементы коллекции

Псевдо-поле CollectionItem регистрирует модель элемента коллекции под заданным именем.

from paper_uploads.models import *


class PageFiles(Collection):
    svg = CollectionItem(SVGItem)
    image = CollectionItem(ImageItem)
    file = CollectionItem(FileItem)

В приведённом примере, коллекция PageFiles может включать элементы трех моделей: SVGItem, ImageItem и FileItem.

Порядок объявления элементов коллекции важен: первый класс модели, чей метод accept() вернет True, определит модель загруженного файла. По этой причине FileItem должен указываться последним, т.к. он принимает любые файлы.

Получить элементы определённого типа можно с помощью метода get_items():

for item in page.files.get_items("image"):
    # ...

В состав библиотеки входят следующие модели элементов:

  • ImageItem
    Для хранения изображения с возможностью нарезки на вариации. Допускются только те файлы, которые можно открыть с помощью Pillow.

  • SVGItem
    Для хранения SVG иконок.

  • FileItem
    Может хранить любой файл.

Storage и каталог загрузки файлов

По умолчанию элементы коллекции используют тот же экземпляр хранилища, что используется полями FileField и ImageField.

Каталоги загрузки файлов для элементов коллекций указываются в настройках COLLECTION_FILES_UPLOAD_TO и COLLECTION_IMAGES_UPLOAD_TO:

# settings.py

PAPER_UPLOADS = {
    # ...
    "COLLECTION_FILES_UPLOAD_TO": "collections/files/%Y/%m/%d",
    "COLLECTION_IMAGES_UPLOAD_TO": "collections/images/%Y/%m/%d",
    # ...
}

Для отдельно взятого элемента коллекции экземпляр хранилища и каталог загрузки
можно указать в параметре options псевдо-поля CollectionItem:

from django.core.files.storage import FileSystemStorage
from paper_uploads.models import *


class PageFiles(Collection):
    image = CollectionItem(ImageItem, options={
        "storage": FileSystemStorage(location="uploads/"),
        "upload_to": "gallery",
    })

Как в случае с FileField и ImageField, значением upload_to не может выступать вызываемый объект.

Если вам требуется динамическое определение каталога или имени загруженного файла, создайте proxy-модель и переопрелите метод generate_filename():

import os
import datetime
from django.db import models
from django.utils.translation import gettext_lazy as _
from paper_uploads.models import *


class ProxyImageItem(ImageItem):
    class Meta:
        proxy = True

    def generate_filename(self, filename: str) -> str:
        _, ext = os.path.splitext(filename)
        filename = "gallery/image-%Y-%m-%d_%H%M%S{}".format(ext)
        filename = datetime.datetime.now().strftime(filename)

        storage = self.get_file_storage()
        return storage.generate_filename(filename)


class PageGallery(Collection):
    image = CollectionItem(ProxyImageItem)


class Page(models.Model):
    gallery = CollectionField(
        PageGallery,
        verbose_name=_("gallery")
    )

Валидаторы

На загружаемые в коллекции файлы можно наложить ограничения с помощью валидаторов:

from django.db import models
from django.utils.translation import gettext_lazy as _
from paper_uploads.models import *
from paper_uploads.validators import ImageMaxSizeValidator, ImageMinSizeValidator


class PageGallery(Collection):
    image = CollectionItem(ImageItem, validators=[
        ImageMinSizeValidator(640, 480),
        ImageMaxSizeValidator(4000, 3000)
    ])


class Page(models.Model):
    gallery = CollectionField(
        PageGallery,
        verbose_name=_("gallery")
    )

Программное создание элемента коллекции

Элементы коллекций создаются почти также, как UploadedFile и UploadedImage. Разница лишь в том, что вместо вызова метода set_owner_field() необходимо вызвать метод attach_to() для присоединения элемента к коллекции:

from paper_uploads.models import *

collection = PageGallery.objects.create()

item = ImageItem()
item.attach_to(collection)
item.attach("/tmp/image.jpg")
item.save()

page = Page.objects.create(
    gallery=collection
)

Вариации

Вариации для изображений коллекции можно указать одним из двух способов:

  1. Параметр options псевдо-поля CollectionItem:

    from paper_uploads.models import *
    
    class PageGallery(Collection):
        image = CollectionItem(ImageItem, options={
            "variations": dict(
                mobile=dict(
                    size=(640, 0),
                    clip=False
                )
            )
        })
    
  2. Атрибут класса коллекции VARIATIONS:

    from paper_uploads.models import *
    
    class PageGallery(Collection):
        VARIATIONS = dict(
            mobile=dict(
                size=(640, 0),
                clip=False
            )
        )
    
        image = CollectionItem(ImageItem)
    

HTML Template Example

{% if page.gallery %}
<div class="gallery">
  {% for item in page.gallery %}
  
    {% if item.type == "image" %}
      <div class="item item--{{ item.type }}">
        <img src="{{ item.url }}" 
             width="{{ item.width }}"
             height="{{ item.height }}"
             title="{{ item.title }}"
             alt="{{ item.description }}">
      </div>
    {% elif item.type == "file" %}}
      <div class="item item--{{ item.type }}">
        <a href="{{ item.url }}" download>
          Download file "{{ item.display_name }}" ({{ item.size|filesizeformat }})
        </a>
      </div>
    {% endif %}}
  
  {% endfor %}
</div>
{% endif %}

Management команды

check_uploads

Запускает комплексную проверку загруженных файлов и выводит результат.

Список производимых тестов:

  • загруженный файл существует
  • модель-владелец (указанная в owner_app_label и owner_model_name) существует
  • в модели-владельце существует поле, указанное в owner_fieldname
  • существует единственный экземпляр модели-владельца, ссылающийся на текущий
  • у элементов коллекций указано корректное значение в поле type
  • модель элемента коллекции идентична модели, указанной в классе коллекции
python3 manage.py check_uploads

clean_uploads

Находит мусорные записи в БД (например те, у которых нет владельца) и предлагает их удалить.

Владелец загруженного файла устанавливается в момент сохранения страницы в интерфейсе администратора. Это происходит позже фактической загрузки файла на сервер. В промежутке времени между этими событиями файл будет являться "сиротой". Для того, чтобы такие файлы не удалялись, команда clean_uploads игнорирует файлы, загруженные в течение последнего часа.

python3 manage.py clean_uploads

remove_empty_collections

Удаление экземпляров коллекций, в которых нет ни одного элемента.

python3 manage.py clean_uploads

create_missing_variations

Создаёт отсутствующие файлы вариаций.

python3 manage.py create_missing_variations

recreate_variations

Создание/перезапись вариаций для всех экземпляров указанной модели. Модель указывается в формате app_label.model_name.

Если модель является коллекцией, необходимо указать параметр --item-type:

python3 manage.py recreate_variations "app.Photos" \
        --item-type="image"

Для обычных моделей необходимо указать параметр --field:

python3 manage.py recreate_variations "app.Page" \
        --field="image"

По умолчанию перенарезаются все возможные вариации для каждого экземпляра указанной модели. Можно указать конкретные вариации, которые нужно перенарезать:

python3 manage.py recreate_variations "app.Page" \
        --field="image" \
        --variations desktop mobile

remove_variations

Удаление файлов вариаций. Удаляются только файлы объявленных вариаций. Параметры аналогичны параметрам recreate_variations.

python3 manage.py remove_variations "app.Page" --field="image"

Cloudinary

Во встроенном модуле paper_uploads.cloudinary находятся поля и классы, позволяющие загружать файлы и картинки в облачный сервис Cloudinary.

Помимо очевидной выгоды от хранения данных в облаке, использование Cloudinary в качестве хранилища файлов даёт возможность пользоваться API для трансформации изображений и медиа.

Installation

  1. pip install cloudinary
  2. Добавить paper_uploads.cloudinary и cloudinary в INSTALLED_APPS.
    INSTALLED_APPS = [
        # ...
        'paper_uploads',
        'paper_uploads.cloudinary',
        'cloudinary',
        # ...
    ]
    
  3. Задать данные учетной записи Cloudinary
    $ export CLOUDINARY_URL=cloudinary://API-Key:API-Secret@Cloud-name?sign_url=1&secure=1
    

Чтобы предотвратить генерацию трасформаций конечными пользователями, рекомендуется включить в вашем аккаунте Cloudinary Strict transformations.

Файловые поля

Вместо FileField и ImageField используются поля CloudinaryFileField, CloudinaryImageField и CloudinaryMediaField.

from django.db import models
from paper_uploads.cloudinary.models import *

class Page(models.Model):
    file = CloudinaryFileField(_('file'), blank=True)
    image = CloudinaryImageField(_('image'), blank=True)
    media = CloudinaryMediaField(_('media'), blank=True)

Дополнительные параметры загрузки Cloudinary можно задать с помощью параметра cloudinary:

from django.db import models
from paper_uploads.cloudinary.models import *


class Page(models.Model):
    file = CloudinaryFileField(_('file'), blank=True, cloudinary={
        "use_filename": False
    })

Коллекции

Для коллекций используется тот же класс Collection, что используется при локальном хранении файлов. Отличаются только классы элементов коллекций.

В состав библиотеки входит три класса элементов коллекции: CloudinaryFileItem, CloudinaryImageItem и CloudinaryMediaItem (для аудио и видео).

from django.db import models
from paper_uploads.models import *
from paper_uploads.cloudinary.models import *


class PageFiles(Collection):
    image = CollectionItem(CloudinaryImageItem)
    file = CollectionItem(CloudinaryFileItem)


class Page(models.Model):
    files = CollectionField(PageFiles)

Также, как и для обычных коллекций, для Cloudinary объявлена готовая коллекция для изображений — CloudinaryImageCollection:

from django.db import models
from paper_uploads.models import *
from paper_uploads.cloudinary.models import *


class PageGallery(CloudinaryImageCollection):
    pass


class Page(models.Model):
    gallery = CollectionField(PageGallery)

paper_cloudinary_url

Для вывода ссылки на файл, загруженный в Cloudinary, библиотека содержит шаблонный тэг paper_cloudinary_url:

{% load paper_cloudinary %}

<img src={% paper_cloudinary_url page.image width=1024 crop=fill %}>

Для jinja2:

<img src={% paper_cloudinary_url page.image, width=1024, crop=fill %}>

Также, для jinja2 доступна одноименная глобальная функция:

<img src={{ paper_cloudinary_url(page.image, width=1024, crop='fill') }}>

Settings

Все настройки указываются в словаре PAPER_UPLOADS.

PAPER_UPLOADS = {
    "STORAGE": "django.core.files.storage.FileSystemStorage",
    "STORAGE_OPTIONS": {},
    "FILES_UPLOAD_TO": "files/%Y/%m/%d",
    "IMAGES_UPLOAD_TO": "images/%Y/%m/%d",
    "COLLECTION_FILES_UPLOAD_TO": "collections/files/%Y/%m/%d",
    "COLLECTION_IMAGES_UPLOAD_TO": "collections/images/%Y/%m/%d",
    
    "RQ_ENABLED": True,
    "RQ_QUEUE_NAME": "default",
    
    "VARIATION_DEFAULTS": {
        "jpeg": dict(
            quality=80,
            progressive=True,
        ),
        "webp": dict(
            quality=75,
        )
    }
}

STORAGE

Путь к классу хранилища Django.

Значение по умолчанию: django.core.files.storage.FileSystemStorage

STORAGE_OPTIONS

Параметры инициализации хранилища.

Значение по умолчанию: {}

FILES_UPLOAD_TO

Путь к папке, в которую загружаются файлы из FileField. Может содержать параметры для даты и времени (см. upload_to).

Значение по умолчанию: files/%Y/%m/%d

IMAGES_UPLOAD_TO

Путь к папке, в которую загружаются файлы из ImageField.

Значение по умолчанию: images/%Y/%m/%d

COLLECTION_FILES_UPLOAD_TO

Путь к папке, в которую загружаются файлы коллекций.

Значение по умолчанию: collections/files/%Y/%m/%d

COLLECTION_IMAGES_UPLOAD_TO

Путь к папке, в которую загружаются изображения коллекций.

Значение по умолчанию: collections/images/%Y/%m/%d

COLLECTION_ITEM_PREVIEW_WIDTH, COLLECTION_ITEM_PREVIEW_HEIGHT

Размеры превью элементов коллекций в админке.

Значение по умолчанию: 180 x 135

COLLECTION_IMAGE_ITEM_PREVIEW_VARIATIONS

Вариации, добавляемые к каждому классу изображений коллекций для отображения превью в админке. Размеры файлов должны совпадать с COLLECTION_ITEM_PREVIEW_WIDTH и COLLECTION_ITEM_PREVIEW_HEIGHT.

RQ_ENABLED

Включает нарезку картинок на вариации через отложенные задачи. Требует наличие установленного пакета django-rq.

Значение по умолчанию: False

RQ_QUEUE_NAME

Название очереди, в которую помещаются задачи по нарезке картинок.

Значение по умолчанию: default

VARIATION_DEFAULTS

Параметры вариаций по умолчанию.

Параметры, указанные в этом словаре, будут применены к каждой вариации — если только вариация их явно не переопределяет.

Значение по умолчанию: None

CLOUDINARY_TYPE

Тип загрузки файлов. Возможные значения: private, upload. Значение по умолчанию: private

CLOUDINARY_TEMP_DIR

Папка в разделе /tmp/, в которую скачиваются файлы из Cloudinary при чтении их содержимого.

CLOUDINARY_UPLOADER_OPTIONS

Словарь, задающий глобальные параметры загрузки для Cloudinary.

Значение по умолчанию:

PAPER_UPLOADS = {
    "CLOUDINARY_UPLOADER_OPTIONS": {
        "use_filename": True,
        "unique_filename": True,
        "overwrite": True,
        "invalidate": True
    }
}

Development and Testing

After cloning the Git repository, you should install this in a virtualenv and set up for development:

virtualenv .venv
source .venv/bin/activate
pip install -r ./requirements.txt
pre-commit install

Install npm dependencies and build static files:

npm ci
npx webpack

Create .env file:

CLOUDINARY_URL=cloudinary://XXXXXXXXXXXXXXX:YYYYYYYYYYYYYYYYYYYYYYYYYYY@ZZZZZZ?sign_url=1&secure=1

Download files

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

Source Distribution

paper-uploads-0.9.2.tar.gz (414.0 kB view hashes)

Uploaded Source

Built Distribution

paper_uploads-0.9.2-py2.py3-none-any.whl (559.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page