https://github.com/apkawa/django-multitype-file-field

For possible use one field for different file type
https://github.com/apkawa/django-multitype-file-field

Last synced: about 1 year ago
JSON representation

For possible use one field for different file type

• Host: GitHub
• URL: https://github.com/apkawa/django-multitype-file-field
• Owner: Apkawa
• License: mit
• Created: 2016-07-29T07:21:01.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2021-07-28T18:05:14.000Z (almost 5 years ago)
• Last Synced: 2025-06-10T04:37:10.713Z (about 1 year ago)
• Language: Python
• Size: 37.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![ci](https://github.com/Apkawa/django-multitype-file-field/actions/workflows/ci.yml/badge.svg)](https://github.com/Apkawa/django-multitype-file-field/actions/workflows/ci.yml)

[![codecov](https://codecov.io/gh/Apkawa/django-multitype-file-field/branch/master/graph/badge.svg)](https://codecov.io/gh/Apkawa/django-multitype-file-field)

[![PyPi ](https://img.shields.io/pypi/v/django-multitype-file-field.svg)](https://pypi.python.org/pypi/django-multitype-file-field)

[![PyPi python versions](https://img.shields.io/pypi/pyversions/django-multitype-file-field.svg)](https://pypi.python.org/pypi/django-multitype-file-field)

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

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

# Installation

```bash

pip install django-multitype-file-field

```

or from git

```bash

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               |       :x:          |      :x:           |       :x:          |      :x:           |

| 1.11              | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |      :x:           |

| 2.2               | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |

| 3.0               |       :x:          | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |

# Usage

## models.py

```python

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:

```python

from tests.models import TestModel

from django.core.files.base import ContentFile

model = TestModel()

model.file # => 

model.file = ContentFile('', name='example.png')

model.file # => 

model.file = ContentFile('', name='example.txt')

model.file # => 

```

# Contributing

## run example app

```bash

pip install -r requirements-dev.txt

./test/manage.py migrate

./test/manage.py runserver

```

## run tests

```bash

pip install -r requirements-dev.txt

pytest

tox

```

## Update version

```bash

python setup.py bumpversion

```

## publish pypi

```bash

python setup.py publish

```