Skip to main content

django-asset-definitions allows to define collections of static files (JavaScript, CSS) in Python code and (re)use them in Django views and templates.

Project description


Build Status Code Coverage

Asset definitions are collections of static files (JavaScript, CSS) defined in Python code and (re)used in Django views and templates.

An example of asset definition is Media class that you can define in Django forms.

django-asset-definitions aim to extend the application of asset definitions beyond forms and use them as the main way to describe and organize JavaScript and CSS files.


pip install django-asset-definitions



import asset_definitions

my_media = asset_definitions.Media(
        """<script>window.addEventListener("load", function() {console.log("Loaded!");});</script>""",
        "all": (


extended_media = my_media + asset_definitions.Media(
    js=("extension.js", )

Define in views:

import asset_definitions

class MyView(asset_definitions.MediaDefiningView, ...):

    class Media:
        js = (
        css = {
            "all": (


Form media is added to view media automatically:

import asset_definitions
from django.views.generic import FormView

class MyFormView(asset_definitions.MediaDefiningView, FormView):

Use in templates:

{{ }}


{{ }}
{{ }}

See an extended example below.

asset_definitions.Media and django.forms.Media

  1. asset_definitions.Media provides the same API as django.forms.Media. In fact, it is inherited from django.forms.Media.

  2. It is safe to combine asset_definitions.Media with django.forms.Media.

  3. asset_definitions.Media objects are lazy. If two or more instances of asset_definitions.Media are combined, the result is computed only when media is rendered. It is safe to use reverse_lazy() with asset_definitions.Media. It is important if you define your assets on a module level.

  4. Media class in MediaDefiningView does not support extend option. To add to the media defined in a parent view class, you should override get_media method and use super(MyView, self).get_media().



urlpatterns = (
    url("/", MyView.as_view()),
    url("/global-variables.js", global_js_variables, name="global_js_variables"),


import asset_definitions
from . import assets

class MyView(assets_definition.MediaDefiningView, TemplateView):

    template_name = "template.html"

    class Media:
        js = ("media.js", )
        css = {"all": ("media.css", )}

    def get_media():
        return (
          assets.global_js_variables +
          assets.jquery +
          super(MyView, self).get_media()

def global_js_variables(request):
    js_content = 'const CURRENT_USER="{}";'.format(request.user)
    return HttpResponse(js_content, content_type="application/javascript")


import asset_definitions
from django.core import urlresolvers

global_js_variables = asset_definition.Media(

jquery = asset_definitions.Media(


    {{ }}
    {{ }}



  • Add Django 3.x and 4.x compatibility

  • Drop support for Python 2

  • Python 3.6 is the minimum requirement


  • Add Django 2.0 compatibility

  • Extract MediaDefiningClass base class from MediaDefiningView


  • Specify different requirements in based on the current Python version

  • Allow using inline JavaScript in media definitions (wrap with <script> tag)


  • Initial release

Project details

Download files

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

Source Distribution

django-asset-definitions-1.0.0.tar.gz (5.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page