Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Compiles and concatenates JavaScript and CSS assets. Inspired by Ruby's Sprockets.
Python Shell JavaScript CoffeeScript
Branch: improve_tests
Pull request Compare This branch is 199 commits behind gears:develop.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
gears
tests
.gitignore
.travis.yml
AUTHORS
LICENSE
MANIFEST.in
Makefile
README.rst
setup.py
tox.ini

README.rst

Gears

https://secure.travis-ci.org/trilan/gears.png?branch=develop

Gears is a library to compile and concatenate JavaScript and CSS assets, highly inspired by Ruby's Sprockets. It includes support for writing scripts, styles and client templates using CoffeeScript, Handlebars, Stylus, Less, SASS and SCSS. New compilers can be also easily added.

There is also an app for Django called django-gears that integrates Gears into Django project. You can read more on the project page.

Features

  • Dependency management using directives in header comments. For example:

    /* Dependencies:
     *= require jquery
     *= require underscore
     *= require backbone
     *= require_directory templates
     */
    

    Three directive types is supported for now:

    • require :path: includes the contents of the asset path suffixed with the same extension as the current asset (e.g., if js/app.js.coffee has directive require views, js/views.js.coffee will be included).
    • require_directory :path: includes the contents of the every asset in the directory path with the same suffix as the current asset in alphabetical order.
    • require_self: includes the contents of the current asset at the current place. If there is no require_self directive, the contents will be appended at the end of asset.
  • Scripting and styling in modern languages like CoffeeScript, Stylus, Less, SASS and SCSS (support for new languages can be easily added).

  • Writing client templates using Handlebars.

  • The list of compilers for the asset is specified with asset extensions appended to the original extension. E.g., for the asset named js/app.js.coffee CoffeeScript compiler will be used. Here are extensions for the supported compilers:

    • CoffeeScript - .js.coffee;
    • Handlebars - .js.handlebars;
    • Stylus - .css.styl;
    • Less - .css.less;
    • SASS - .css.sass;
    • SCSS - .css.scss.
  • Caching

Installation

You can install Gears using pip:

$ pip install Gears

If you want to use compilers you need to install other dependencies:

  • coffee-script, handlebars, stylus, less node.js modules for CoffeeScript, Handlebars, Stylus, Less support respectively;
  • sass Ruby gem for SASS and SCSS support.

Usage

This example compiles public assets (assets/js/script.js and assets/css/style.css by default) from assets directory to static:

import os

from gears.environment import Environment
from gears.finders import FileSystemFinder


ROOT_DIR = os.path.abspath(os.path.dirname(__file__))
ASSETS_DIR = os.path.join(ROOT_DIR, 'assets')
STATIC_DIR = os.path.join(ROOT_DIR, 'static')

os.environ['NODE_PATH'] = os.path.join(ROOT_DIR, 'node_modules')

env = Environment(STATIC_DIR)
env.finders.register(FileSystemFinder([ASSETS_DIR]))
env.register_defaults()

if __name__ == '__main__':
    env.save()

There is already mentioned django-gears app, which you may want to use in your Django projects.

Contributing

Feel free to fork, send pull requests or report bugs and issues on github.

Something went wrong with that request. Please try again.