django-qiniu icon indicating copy to clipboard operation
django-qiniu copied to clipboard

Qiniu(http://www.qiniu.com) is a cloud storage service, this package interages it with django framework.

NOTE: This package is outdated and unmaintained, please take a look at other modern packages like django-qiniu-storage(https://github.com/glasslion/django-qiniu-storage), which uses a better appoarch by customizing django storage class.

django-qiniu

This package interages Qiniu_ cloud storage with Django_ framework. You must install qiniu's python-sdk_ before using this package.

Configuration

Add below lines in your django project's settings.py:

.. code:: python

QINIU_ACCESS_KEY = 'your_key'
QINIU_SECRET_KEY = 'your_secret'
QINIU_BUCKET_DEFAULT = 'your_bucket_name'

How To Use

Use django-qiniu in your django project is very simple. First of all, your must copy django_qiniu directory to your PYTHON_PATH so you can import it.

  1. Add Field To Your Model

To get started, you should add `QiniuFileField` or `QiniuImageField` to your models.py.

.. code:: python

    from django.db import models
    from django_qiniu.fields import QiNiuImageField, QiniuFileField

    def qiniu_key_maker_file(instance, filename):
        """
        
        Args:
        ~~~~~

        - instance, your model instance being saved
        - filename, original filename
        
        This function should return a string object which is the key of qiniu.
        """

    def qiniu_key_maker_user_image(instance, filename):
        pass

    class Photo(models.Model):
        qiniu_file = QiNiuFileField(upload_to=qiniu_key_maker_file, null=True)
        qiniu_image = QiNiuImageField(upload_to=qiniu_key_maker_image, null=True)

QiniuFileField's __init__ method receives some parameters:

- ``upload_to``, a function to generate qiniu file key.
- ``upload_bucket``, bucket_name, if not given, will use settings.QINIU_BUCKET_DEFAULT as default.
- ``domain``, your customized qiniu static domain, will use ('%s.qiniudn.com' % upload_bucket)
  as default if not given.

QiniuImageField is a subclass of QiniuFileField and designed to store especially image files.

2. Save your uploaded file in views.py

Save your uploaded file to qiniu server is very simple:

.. code:: python

f = request.FILES['file']
obj = Photo()
obj.qiniu_file = f
# Calling save method will upload this file to qiniu server and requires network
# connection
obj.save()

How to use saved qiniu instance?

QiniuFileField


You can get the file url by: **instance.qiniu_file.url**

QiniuImageField

For QiniuImageField, There is a convient method called get_image_view which is used to get thumbnails of your images, such as:

.. code:: python

instance.qiniu_image.get_image_view(mode=1, width=280, height=280, quality=75)
instance.qiniu_image.get_image_view(mode=2, width=640, quality=75)

For more information, visit(http://docs.qiniu.com/api/v6/image-process.html)

.. _Qiniu: http://www.qiniu.com .. _Django: https://www.djangoproject.com/ .. _Qiniu's python-sdk: https://github.com/qiniu/python-sdk