Skip to content

Apkawa/django-multitype-file-field

Repository files navigation

ci codecov

PyPi PyPi python versions MIT License

Project for merging different file types, as example easy thumbnail image and unpacking archive in one field

Installation

pip install django-multitype-file-field

or from git

pip install -e git+https://github.com/Apkawa/django-multitype-file-field.git#egg=django-multitype-file-field

Django and python version

Python
Django
3.5 3.6 3.7 3.8
1.8
1.11 ✔️ ✔️ ✔️
2.2 ✔️ ✔️ ✔️ ✔️
3.0 ✔️ ✔️ ✔️

Usage

models.py

from django.db import models

from multitype_file_field.fields import MultiTypeFileField

# as example, with easy_thumbnails
from easy_thumbnails.fields import ThumbnailerImageField


class FileModel(models.Model):
    file = MultiTypeFileField(upload_to='test_archive',
        fields={
            None: models.FileField, # Fallback
            'image/svg+xml': models.FileField, # high priority,
            'image': (
                ThumbnailerImageField, 
                dict(resize_source=dict(size=(100, 100), sharpen=True, crop='smart'))
                ), # tuple, Field and args
            
        }
    )

Usage:

from tests.models import TestModel
from django.core.files.base import ContentFile
model = TestModel()
model.file # => <FieldFile: None>
model.file = ContentFile('', name='example.png')
model.file # => <ImageFieldFile: example.png>
model.file = ContentFile('', name='example.txt')
model.file # => <FieldFile: example.txt>

Contributing

run example app

pip install -r requirements-dev.txt
./test/manage.py migrate
./test/manage.py runserver

run tests

pip install -r requirements-dev.txt
pytest
tox

Update version

python setup.py bumpversion

publish pypi

python setup.py publish

About

For possible use one field for different file type

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages