Collectfast 1.1.0

A Faster Collectstatic

A faster collectstatic command.

Features

• Compares and caches file checksums before uploading

• Parallelizes file uploads using Python’s multiprocessing module

Supported Storage Backends

• storages.backends.s3boto.S3BotoStorage (deprecated)

• storages.backends.s3boto3.S3Boto3Storage

Running Django’s collectstatic command can become painfully slow as more and more files are added to a project, especially when heavy libraries such as jQuery UI are included in source code. Collectfast customizes the builtin collectstatic command, adding different optimizations to make uploading large amounts of files much faster.

Installation

Install the app using pip:

$ pip install Collectfast

Make sure you have this in your settings file and add 'collectfast' to your INSTALLED_APPS, before 'django.contrib.staticfiles':

STATICFILES_STORAGE = "storages.backends.s3boto3.S3Boto3Storage"
COLLECTFAST_STRATEGY = "collectfast.strategies.boto3.Boto3Strategy"
INSTALLED_APPS = (
    # ...
    'collectfast',
)

Collectfast comes with these upload strategies:

• collectfast.strategies.boto.BotoStrategy for storages.backends.s3boto.S3BotoStorage

• collectfast.strategies.boto3.Boto3Strategy for storages.backends.s3boto3.S3Boto3Storage

Note: 'collectfast' must come before 'django.contrib.staticfiles' in INSTALLED_APPS.

Note: Boto strategies will set preload_metadata on the remote storage to True, see #30.

Usage

Collectfast overrides Django’s builtin collectstatic command so just run python manage.py collectstatic as normal. You can disable Collectfast by using the --disable-collectfast option.

You can also disable collectfast by setting COLLECTFAST_ENABLED = False in your settings file. This is useful when using a local file storage backend for development.

Setup Dedicated Cache Backend

It’s recommended to setup a dedicated cache backend for Collectfast. Every time Collectfast does not find a lookup for a file in the cache it will trigger a lookup to the storage backend, so it’s recommended to have a fairly high TIMEOUT setting.

Set up your dedicated cache in settings.py with the COLLECTFAST_CACHE setting:

CACHES = {
    'default': {
        # Your default cache
    },
    'collectfast': {
        # Your dedicated Collectfast cache
    }
}

COLLECTFAST_CACHE = 'collectfast'

By default Collectfast will use the default cache.

Note: Collectfast will never clean the cache of obsolete files. To clean out the entire cache, use cache.clear(). Read more about Django’s cache framework.

Note: We recommend you to set the MAX_ENTRIES setting if you have more than 300 static files, see #47

Enable Parallelization

The parallelization feature enables parallel file uploads using Python’s multiprocessing module. Enable it by setting the COLLECTFAST_THREADS setting.

To enable parallelization of file copying, a dedicated cache backend must be setup and it must use a backend that is threadsafe, i.e. something other than Django’s default LocMemCache.

COLLECTFAST_THREADS = 20

Debug

By default, Collectfast will suppress any exceptions that happens when copying and let Django’s collectstatic handle it. To debug those suppressed errors you can set COLLECTFAST_DEBUG = True in your Django settings file.

Contribution

Please feel free to contribute by using issues and pull requests. Discussion is open and welcome.

Testing

The test suite is built to run against an S3 bucket. To be able to test locally you need to provide AWS credentials for a bucket to test against. Add the credentials to a file named aws-credentials in the root of the project directory:

export AWS_ACCESS_KEY_ID=''
export AWS_SECRET_ACCESS_KEY=''

Install test dependencies and target Django version:

pip install -r test-requirements.txt
pip install django==2.2

Run test suite:

make test

Code quality tools are broken out from test requirements because some of them only install on Python >= 3.7.

pip install -r lint-requirements.txt

Run linters and static type check:

make lint

License

Collectfast is licensed under the MIT License, see LICENSE file for more information.