Django app extras for AX3 models
Project description
AX3 Model Extras
Installation
AX3 Model Extras is easy to install from the PyPI package:
$ pip install ax3-model-extras
To enable ax3_model_extras in your project you need to add it to INSTALLED_APPS in your projects settings.py file:
INSTALLED_APPS = (
...
'ax3_model_extras',
...
)
Validate image size
If you want to validate the dimension and file size for images:
from ax3_model_extras.validators import FileSizeValidator, ImageDimensionValidator
class Post(models.Model):
title = models.CharField()
slug = models.SlugField()
image = models.ImageField(
validators=[ImageDimensionValidator([1920, 800]), FileSizeValidator(350)],
help_text='JPG. 1920x800px. 350kb max.',
)
If you want to validate one dimension, you have to send the other dimension with 0
from ax3_model_extras.validators import FileSizeValidator, ImageDimensionValidator
class Post(models.Model):
title = models.CharField()
slug = models.SlugField()
image = models.ImageField(
validators=[ImageDimensionValidator([1920, 0]), FileSizeValidator(350)],
help_text='JPG. width=1920px. 350kb max.',
)
Improve file storage
If you want to improve the local file storage or use S3 upload:
from ax3_model_extras.storages import get_storage, get_upload_path
class Post(models.Model):
title = models.CharField()
slug = models.SlugField()
image = models.ImageField(
upload_to=get_upload_path,
storage=get_storage(),
)
Optimize images before upload them.
Use as:
from ax3_model_extras.fields import OptimizedImageField
class Post(models.Model):
title = models.CharField()
slug = models.SlugField()
image = OptimizedImageField()
If want to set the size of the image using the 'cover' method do:
image = OptimizedImageField(
optimized_image_output_size=(1920, 800),
)
If want to set the size of the image using the 'thumbnail' method do:
image = OptimizedImageField(
optimized_image_output_size=(1920, 800),
optimized_image_resize_method='thumbnail',
)
If want to restrict the file format do (If not set it supports JPEG, PNG and GIF):
image = OptimizedImageField(
optimized_image_output_size=(1920, 800),
optimized_image_resize_method='thumbnail',
optimized_file_formats=['PNG'],
)
If want to specific quality of the image (If not set it default = 75):
image = OptimizedImageField(
optimized_image_output_size=(1920, 800),
optimized_image_resize_method='thumbnail',
optimized_file_formats=['PNG'],
optimized_image_quality=85.5,
)
Resize is done using python-resize-image
Releasing a new version
Make sure you increase the version number and create a git tag:
$ python3 -m pip install --user --upgrade setuptools wheel twine
$ ./release.sh
Made by Axiacore.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for AX3_model_extras-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 322d288633ffc3740273dfc27f589aaacbf7682050d4e1c3bd9b671071af9df0 |
|
MD5 | 0e8c9549893284ea43ab0f8eb30841d9 |
|
BLAKE2b-256 | c0e58144c1c2a295e80eecfa614d88906227e1bfc747a4fcc59e22837b317d1e |