Cloudflare Images integration for Django
Project description
django-cloudflare-images
This is a Django library to add support to Cloudflare Images to the ImageField.
Installation
pip install django-cloudflare-images
Setup
You need to add the following your settings.py:
- If you are running Django 4.2+:
STORAGES = {"default": {"BACKEND": "cloudflare_images.storage.CloudflareImagesStorage"}}
- Else:
DEFAULT_FILE_STORAGE = "cloudflare_images.storage.CloudflareImagesStorage"
And then add the remaining of the configuration:
CLOUDFLARE_IMAGES_ACCOUNT_ID = "XXX"
CLOUDFLARE_IMAGES_API_TOKEN = "YYY"
CLOUDFLARE_IMAGES_ACCOUNT_HASH = "ZZZ"
If you wish to use a default variant for a specific field you need to change your ImageField
to a CloudflareImagesField
see example below:
from cloudflare_images.field import CloudflareImagesField
from django.db import models
class MyModel(models.Model):
image = CloudflareImagesField(variant="custom")
Please note that you will need to migrate your model(s) once you swapped the field(s). No SQL will actually be applied (you can check by running sqlmigrate <module> <number>
).
If you wish to use a custom domain to serve your images you need to add the following to your settings.py:
CLOUDFLARE_IMAGES_DOMAIN = "example.com"
If you wish to use a default variant other than "public" to serve your images you need to add the following to your settings.py:
CLOUDFLARE_IMAGES_VARIANT = "custom"
Development
Installing for development:
make install
Cleaning the installation:
make clean
Format the code:
make format
Running all tests:
make test
Create a sdist+bdist package in dist/:
make package
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 django-cloudflare-images-0.5.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f733760d3313fd744fbd458acb05cbc56c808ededfb7dace4f8a267ee71b0a6a |
|
MD5 | 8d02006b46579bb78cea77d386533a07 |
|
BLAKE2b-256 | e165e2bf799d0d26f6bfdebda53d502f6b16bb67920a88a3018e73a4140652f0 |
Hashes for django_cloudflare_images-0.5.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef6f3c08cc1a079ad47537b674f66a105f15019c1c2c4b90e33113a92824a7bd |
|
MD5 | 14cdc40d06480008edf0fadfa0f05080 |
|
BLAKE2b-256 | 22c98ff46d64bcee4c9813ebbf908f2e1503579f3fa06b6b43bb244358eba78c |