Welcome to dj-libcloud’s documentation!¶

Documentation¶

The full documentation is at https://dj-libcloud.readthedocs.org.

Quickstart¶

Libcloud verifies server SSL certificates before it lets you do anything. It will search your system for the CA certificate, and if it doesn’t find it then it will blow up. See https://libcloud.readthedocs.org/en/latest/other/ssl-certificate-validation.html

Installing CA certificate bundle on Mac OS X:

# Assuming you are using homebrew for Mac OS X dependency management.
$ brew install curl-ca-bundle

Install dj-libcloud:

$ pip install dj-libcloud

Then use it in a project, e.g. for your static files:

# settings.py

STATIC_URL = 'https://s3.amazonaws.com/my-assets/'
STATICFILES_STORAGE = 'djlibcloud.storage.LibCloudStorage'

LIBCLOUD_PROVIDERS = {
    'default': {
        'type': 'libcloud.storage.types.Provider.S3',
        'user': os.environ.get('AWS_ACCESS_KEY'),
        'key': os.environ.get('AWS_SECRET_KEY'),
        'bucket': 'my-assets',
        'secure': True,
    },
}

Other LibCloud Providers¶

If you want to use other libcloud providers (Rackspace, Openstack, other AWS centers, et al), please visit:

• The libcloud list of supported providers
• The dj-libcloud cookbook.

Features¶

• Works for uploading media assets using Python 3.3 and Django 1.6.
• In theory supports all the backends that libcloud supports.

FAQ¶

Because you just had to ask.

CREDIT¶

Many thanks to Jannis Leidel (@jezdez) for giving me the code to get this started. He’s a Django core developer, the master of Django static asset managment, and overall a great great guy.

Amazon¶

STATIC_URL = 'https://s3-eu-west-1.amazonaws.com/my-assets/'
STATICFILES_STORAGE = 'djlibcloud.storage.LibCloudStorage'

LIBCLOUD_PROVIDERS = {
    'amazon_s3_eu_west': {
        'type': 'libcloud.storage.types.Provider.S3_EU_WEST',
        'user': os.environ.get('AWS_ACCESS_KEY'),
        'key': os.environ.get('AWS_SECRET_KEY'),
        'bucket': 'my-assets',
        'secure': True,
    },
}

DEFAULT_LIBCLOUD_PROVIDER = 'amazon_s3_eu_west'

Google Cloud Storage¶

STATIC_URL = 'https://storage.googleapis.com/my-assets/'
STATICFILES_STORAGE = 'djlibcloud.storage.LibCloudStorage'

LIBCLOUD_PROVIDERS = {
    'google_cloud_storage': {
        'type': 'libcloud.storage.types.Provider.GOOGLE_STORAGE',
        'user': os.environ.get('GOOGLE_ACCESS_KEY'),
        'key': os.environ.get('GOOGLE_SECRET_KEY'),
        'bucket': 'my-assets',
        'secure': True,
    },
}

DEFAULT_LIBCLOUD_PROVIDER = 'google_cloud_storage'

Rackspace Cloudfiles¶

STATIC_URL = 'https://<long>-<hash>.ssl.cf5.rackcdn.com'
STATICFILES_STORAGE = 'djlibcloud.storage.LibCloudStorage'

LIBCLOUD_PROVIDERS = {
    'rackspace_cloudfiles': {
        'type': 'libcloud.storage.types.Provider.CLOUDFILES',
        'user': os.environ.get('RACKSPACE_USER_NAME'),
        'key': os.environ.get('RACKSPACE_API_KEY'),
        'bucket': 'my-assets',
        'secure': True,
    },
}

DEFAULT_LIBCLOUD_PROVIDER = 'rackspace_cloudfiles'

Microsoft Azure¶

AZURE_ACCOUNT_NAME = os.environ.get('AZURE_ACCOUNT_NAME')
STATIC_URL = 'https://%s.blob.core.windows.net/my-assets/' % AZURE_ACCOUNT_NAME
STATICFILES_STORAGE = 'djlibcloud.storage.LibCloudStorage'

LIBCLOUD_PROVIDERS = {
    'microsoft_azure': {
        'type': 'libcloud.storage.types.Provider.AZURE_BLOBS',
        'user': AZURE_ACCOUNT_NAME,
        'key': os.environ.get('AZURE_ACCOUNT_KEY'),
        'bucket': 'my-assets',
        'secure': True,
    },
}

DEFAULT_LIBCLOUD_PROVIDER = 'microsoft_azure'

Using django-pipeline¶

# core/storage.py

from djlibcloud.storage import LibCloudStorage
from pipeline.storage import PipelineMixin

class PipelineCloudStorage(PipelineMixin,
                           LibCloudStorage):
    """ UNTESTED! """
    pass

# settings.py
STATICFILES_STORAGE = 'core.storage.PipelineCloudStorage'

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up dj-libcloud for local development.

1. Fork the dj-libcloud repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/dj-libcloud.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv dj-libcloud
   $ cd dj-libcloud/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

$ flake8 djlibcloud tests
$ python setup.py test
$ tox

To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.7, and 3.3. Check https://travis-ci.org/pydanny/dj-libcloud/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_djlibcloud

Development Lead¶

• Daniel Greenfeld <pydanny@gmail.com>
• Jannis Leidel

Contributors¶

None yet. Why not be the first?

0.2.0(2014-06-23)¶

• Updated url method to return correct values for Rackspace Cloudfiles, Microsoft Azure, Google Storage, non-US Amazon SV (Thanks Jannis!)
• Improved the cookbook immensely (Thanks Jannis!)
• Add link from README to cookbook
• Fix url method for Google Storage, Rackspace Cloudfiles and Microsoft Azure. Also return the correct value for non-US Amazon S3 buckets.

0.1.2 (2014-04-24)¶

• Confirmed to work with Python 2.7
• Remove django-pipeline specific code from storages
• Add cookbook to docs that includes django-pipeline

0.1.1 (2014-04-21)¶

• Fixed second-time run problem by just using LibCloudStorage class
• Made django-pipeline optional
• Removed unnecessary files
• Moved TODO to issue tracker

0.1.0 (2014-04-21)¶

• First release on PyPI.
• Frustration over lack of easy media asset support for Django and Python 3.