Skip to main content

Django template plugin to be used to simplify static CDN resources connecting.

Project description

Django CDNJS

Django CDNJS is the small template tag, that allows you to load external cdn resources by name. You can download any required CDN as well as use only CDN's URL by disabling/enabling resource downloading.

How it works

Website https://cdnjs.com has an API for all cdn repositories stored at database. This API was used in django-cdnjs.

Installation

Install pip-package

pip install django-cdnjs

Add cdnjs to your installed apps:

INSTALLED_APPS = (
    ...
    'cdnjs',
)

# Configure settings
CDNJS_STATIC_ROOT = os.path.join(BASE_DIR, 'static', 'cdn')
CDNJS_STATIC_URL = '/static/cdn/' # With "/" at end of string

Usage example

If you will not provide filename from repository, which url you need, django-cdnjs will return default repository file. For example font-awesome default file is css/font-awesome.min.css

Same for version - django-cdnjs will load latest available version and not always stable

default-files.html

{% load cdnjstag %}

<!DOCTYPE html>
...

<link rel="stylesheet" href="{% cdn "font-awesome" %}">
<script type="text/javascript" src="{% cdn "jquery" %}"></script>
...

Usually you can specify which version you need to be loaded. Just add slash after repository name and specify version. Example:

specify-version.html

{% load cdnjstag %}

<!DOCTYPE html>
...

<link rel="stylesheet" href="{% cdn "font-awesome/4.7.0" %}">
<script type="text/javascript" src="{% cdn "jquery/3.2.1" %}"></script>
...

Second optional argument of cdn tag is the file which should be selected to build cdn-url or local-uri. For example, repository of the boostrap css framework has css-files as well as js. CDNJS provides js-file as the default, so we need to specify manually which file do we need.

specify-file.html

{% load cdnjstag %}

<!DOCTYPE html>
...

<link rel="stylesheet" href="{% cdn "bootstrap/3.3.7" "bootstrap.min.css" %}">
<script type="text/javascript" src="{% cdn "jquery/3.2.1" %}"></script>
<script type="text/javascript" src="{% cdn "bootstrap/3.3.7" "bootstrap.min.js" %}"></script>
...

And here you can see that I had some typo in repository name. But cdnjs API returns results by query term bootstrap and twitter-bootstrap is the first of them. So you can make typos.

Configuration

Required options

Anyway, you should provide two django settings module properties

# This property uses not only for storing remote repositories,
# but for cdn urls cache too. So this option is required. 
CDNJS_STATIC_ROOT = os.path.join(BASE_DIR, 'static', 'cdn')
    
# This option is required, because I don't now why. You should
# know that it's so. Even if you using FORCE_CDN.
# If you want, you can contribute it and fix. =)
CDNJS_STATIC_URL = '/static/cdn/' # With "/" at end of string

Do not load remote repository

By default cdnjs downloads remote repository to be used without accessing remote resources.

# If you need to use only local urli without CDN loading,
# just set this option to True
CDNJS_USE_LOCAL = True
 
# True - download remote repository and use local URI
# False - (default) do not download remote repository and use CDN URI

Settings

Option Default Required Comment
CDNJS_STATIC_ROOT None True Absolute path to the cdn static root.
CDNJS_STATIC_URL None True Absolute path to the cdn static url.
CDNJS_USE_LOCAL False False Should tag download requested repository and use local URI instead of CDN URI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-cdnjs, version 2018.10.11.post1
Filename, size File type Python version Upload date Hashes
Filename, size django-cdnjs-2018.10.11.post1.linux-x86_64.tar.gz (9.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page