django-cumulus¶

The aim of django-cumulus is to provide a set of tools to utilize Rackspace Cloud Files through Django. It currently includes a custom file storage class, CloudFilesStorage.

changelog¶

Version 1.0.5, 30 January 2012¶

Added CloudFilesStaticStorage subclass for collectstatic compatability
Added thread-safe CloudFilesStorage subclass
Added four new management commands
Added creation of pseudo-directories
Numerous bug fixes and code cleanups
Created new example project based on Django 1.3
Updated tox configuration
Bumped python-cloudfiles requirement to 1.7.9.3

Version 1.0.4, 02 September 2011¶

Added USE_SSL setting, which outputs SSL URLs. Thanks to @whafro for the nudge.

Version 1.0.3, 07 June 2011¶

Added context processor for using container URLs in templates for statically synced media

Version 1.0.2, 05 May 2011¶

Added CUMULUS_CNAMES setting to map cloudfiles URIs to CNAMEs

Version 1.0, 03 March 2011¶

OK, srsly. Time for 1.0.
Fixed content_type bug
Bumped python-cloudfiles requirement to 1.7.8

Version 0.3.6, 19 January 2011¶

Added containerinfo management command
Properly integrated CUMULUS_USE_SERVICENET into storage backend
Resolved issue 5, adding CUMULUS_TIMEOUT setting to specify default connection timeout
Restructured tests to work properly with django-nose

Version 0.3.5, 07 January 2011¶

Fixed glaring issue affecting Django > 1.1.x (see http://bit.ly/e8YhcR)
Removed reliance on physical files for tests
Added tox config to test multiple versions of Python and Django

Version 0.3.4, 13 September 2010¶

Reverted exception handling to pre-2.6 style
Added example project to repo

Version 0.3.3, 12 July 2010¶

Removed reliance on bitbucket tag download files

Version 0.3.2, 12 July 2010¶

Pulled in Ian Schenck’s delete_object fix

Version 0.3.1, 18 May 2010¶

Fixed syncstatic deletion bug
Require verbosity > 1 for syncstatic output

Version 0.3, 17 May 2010¶

Added syncstatic management command

Version 0.2.3, 03 May 2010¶

Fix bug when accessing imagekit attributes
Fix setup.py distribute installation issue

Version 0.2.2, 11 February 2010¶

Fixed bug when using django-imagekit

Version 0.2, 10 February 2010¶

Changed focus and aim of project
Removed all previous custom admin work
Incorporated CloudFilesStorage custom storage backend
Added sphinx docs
Converted setup to use distribute

Version 0.1, 28 July 2009¶

Initial release

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/richleland/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'
}
DEFAULT_FILE_STORAGE = 'cumulus.storage.CloudFilesStorage'

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

from cumulus.storage import CloudFilesStorage

cloudfiles_storage = CloudFilesStorage()

class Photo(models.Model):
    image = models.ImageField(storage=cloudfiles_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 media¶

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.CloudFilesStaticStorage'

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 Cloud Files 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¶

syncstatic¶

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

Add the following required settings:

CUMULUS = {
    'STATIC_CONTAINER': 'MyStaticContainer', # the name of the container to sync with
    'SERVICENET': False, # whether to use rackspace's internal private network
    'FILTER_LIST': [] # a list of files to exclude from sync
}

Invoke the management command:

django-admin.py syncstatic

You can also perform a test run:

django-admin.py syncstatic -t