django-cumulus 1.0.20-6-gc285619-dirty¶

django-cumulus provides a set of tools to utilize the python-swiftclient and Rackspace Cloud Files API from Django. It includes a custom file storage class, CumulusFilesStorage.

More documentation about the usage and installation of django-cumulus can be found on django-cumulus.readthedocs.org.

The source code for django-cumulus can be found and contributed to on github.com/django-cumulus/django-cumulus. There you can also file issues.

This documentation applies to the version 1.0.20-6-gc285619-dirty of django-cumulus. To find out what’s new in this version, please see the changelog

Installation¶

To install the latest release from PyPI using pip:

pip install django-cumulus

To install the development version using pip:

pip install -e git://github.com/django-cumulus/django-cumulus.git#egg=django-cumulus

Add cumulus to INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'cumulus',
    ...
)

Usage¶

Add the following to your project’s settings.py file:

CUMULUS = {
    'USERNAME': 'YourUsername',
    'API_KEY': 'YourAPIKey',
    'CONTAINER': 'ContainerName',
    'PYRAX_IDENTITY_TYPE': 'rackspace',
}
DEFAULT_FILE_STORAGE = 'cumulus.storage.CumulusStorage'

The PYRAX_IDENTITY_TYPE parameter can either be rackspace or keystone depending on whether you use Rackspace or OpenStack respectively.

Alternatively, if you don’t want to set the DEFAULT_FILE_STORAGE, you can do the following in your models:

from cumulus.storage import CumulusStorage

swiftclient_storage = CumulusStorage()

class Photo(models.Model):
    image = models.ImageField(storage=swiftclient_storage, upload_to='photos')
    alt_text = models.CharField(max_length=255)

Then access your files as you normally would through templates:

<img src="{{ photo.image.url }}" alt="{{ photo.alt_text }}" />

Or through Django’s default ImageField or FileField api:

>>> photo = Photo.objects.get(pk=1)
>>> photo.image.width
300
>>> photo.image.height
150
>>> photo.image.url
http://c0000000.cdn.cloudfiles.rackspacecloud.com/photos/some-image.jpg

Static files¶

django-cumulus will work with Django’s built-in collectstatic management command out of the box. You need to supply a few additional settings:

CUMULUS = {
    'STATIC_CONTAINER': 'YourStaticContainer'
}
STATICFILES_STORAGE = 'cumulus.storage.CumulusStaticStorage'

Context Processor¶

django-cumulus includes an optional context_processor for accessing the full CDN_URL of any container files from your templates.

This is useful when you’re using Cumulus to serve you static media such as css and javascript and don’t have access to the ImageField or FileField’s url() convenience method.

Add cumulus.context_processors.cdn_url to your list of context processors in your project’s settings.py file:

TEMPLATE_CONTEXT_PROCESSORS = (
    ...
    'cumulus.context_processors.cdn_url',
    ...
)

Now in your templates you can use {{ CDN_URL }} to output the full path to local media:

<link rel="stylesheet" href="{{ CDN_URL }}css/style.css">

Management commands¶

syncfiles¶

This management command synchronizes a local static or media folder with respective remote containers. A few extra settings are required to make use of the command.

Add the following required settings:

CUMULUS = {
    'CONTAINER': 'MyMediaContainer', # the name of the media container to sync with
    'STATIC_CONTAINER': 'MyStaticContainer',  # the name of the static container to sync with
    'SERVICENET': False,  # whether to use rackspace's internal private network
}

Invoke the management command:

django-admin.py syncfiles --static

django-admin.py syncfiles --media

You can also perform a test run:

django-admin.py syncfiles --test-run