https://github.com/zacharyvoase/django-jsmin

Easy JavaScript minification for Django.
https://github.com/zacharyvoase/django-jsmin

Last synced: about 2 months ago
JSON representation

Easy JavaScript minification for Django.

• Host: GitHub
• URL: https://github.com/zacharyvoase/django-jsmin
• Owner: zacharyvoase
• License: unlicense
• Created: 2010-04-08T14:17:42.000Z (over 15 years ago)
• Default Branch: master
• Last Pushed: 2010-04-08T14:21:03.000Z (over 15 years ago)
• Last Synced: 2025-03-24T05:34:47.786Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 771 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# `django-jsmin`

`django-jsmin` is a reusable application for [Django][] which simplifies and automates the process of [minifying][] your JavaScript libraries.

  [django]: http://www.djangoproject.com/

  [minifying]: http://www.crockford.com/javascript/jsmin.html

## Why Minify?

Minified JS is usually much smaller than regular JS. Comments and whitespace are very helpful when developing JavaScript code, but in production they just take up valuable network bandwidth. The effects of minifying code could range from faster page load times to smaller bandwidth bills from your hosting provider.

Minification can also obfuscate your code (making it difficult for third parties to copy), although effective obfuscation isn’t guaranteed, since it’s more of a side-effect of the minification process.

## Installation and Setup

*   Install the `django-jsmin` library:

        $ pip install django-jsmin # OR

        $ easy_install django-jsmin

    

    These commands will both install all the required dependencies.

*   Add `'djjsmin'` to your `INSTALLED_APPS` setting.

*   Add the necessary settings to your `settings.py` file:

        ## somewhere in settings.py

        JSMIN_ROOT = '/path/to/my/project/'

        

        # JSMIN_INPUT contains a list of all the input files and URLs.

        JSMIN_INPUT = [

            'http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.js',

            'media/js/jquery.*.js', # jQuery plugins

            'media/js/*.src.js', # project-specific libraries

        ]

        

        JSMIN_OUTPUT = 'media/js/project.min.js'

    

    More information on the available settings can be found [here](http://github.com/zacharyvoase/django-jsmin/blob/master/doc/wiki/settings.md).

## `DEBUG` mode

If `DEBUG` is set to `True` in your Django project when you run `django-jsmin`,

the JavaScript files will only be concatenated to the output file, not

compressed. This allows you to debug your code with meaningful line numbers

during development, and then use the fully-minified version in production. You

can force specific behaviour with options to the `djboss jsmin` command; see the

output of `djboss jsmin --help` for more information.

## Usage

`django-jsmin` uses [`django-boss`][djboss], a library/tool for writing and

running Django management commands. This will be installed automatically by

setuptools when you install `django-jsmin`.

  [djboss]: http://github.com/zacharyvoase/django-boss

Usage is relatively simple:

    $ djboss --log-level DEBUG jsmin

    Saving http://ajax.googleapis.com/.../jquery.js to a temporary file

    Saved http://ajax.googleapis.com/.../jquery.js to tmpN7MAsi

    Reading tmpN7MAsi

    Reading media/js/jquery.plugin1.js

    Reading media/js/jquery.plugin2.js

    Reading media/js/app-specific.lib.js

    Writing to media/js/minified.min.js

    Cleaning temporary file tmpN7MAsi

The JS file will be output to the filename given by the `JSMIN_OUTPUT` setting, in this case `media/js/minified.min.js`.

## (Un)license

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this

software, either in source code form or as a compiled binary, for any purpose,

commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this

software dedicate any and all copyright interest in the software to the public

domain. We make this dedication for the benefit of the public at large and to

the detriment of our heirs and successors. We intend this dedication to be an

overt act of relinquishment in perpetuity of all present and future rights to

this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS

FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE

LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF

CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to